Class ClrToSdlStream

Namespace

Sdl3Sharp.IO

Assembly

Sdl3Sharp.dll

Represents an SDL Stream that wraps a .NET (CLR) Stream

public sealed class ClrToSdlStream : Stream, IDisposable

Inheritance

object

Stream

ClrToSdlStream

Implements

IDisposable

Inherited Members

Stream.IsValid

Stream.Length

Stream.Properties

Stream.Position

Stream.SdlIOStream

Stream.Status

Stream.Dispose()

Stream.TryClose()

Stream.TryFlush()

Stream.TryLoad(out NativeMemoryManager, bool)

Stream.TryRead(NativeMemory, out nuint)

Stream.TryRead(Span<byte>, out int)

Stream.TryRead(void*, nuint, out nuint)

Stream.TryRead<T>(out T, out nuint)

Stream.TryReadDoubleBE(out double)

Stream.TryReadDoubleLE(out double)

Stream.TryReadHalfBE(out Half)

Stream.TryReadHalfLE(out Half)

Stream.TryReadInt128BE(out Int128)

Stream.TryReadUInt128LE(out Int128)

Stream.TryReadInt16BE(out short)

Stream.TryReadInt16LE(out short)

Stream.TryReadInt32BE(out int)

Stream.TryReadInt32LE(out int)

Stream.TryReadInt64BE(out long)

Stream.TryReadInt64LE(out long)

Stream.TryReadInt8(out sbyte)

Stream.TryReadIntPtrBE(out nint)

Stream.TryReadIntPtrLE(out nint)

Stream.TryReadSingleBE(out float)

Stream.TryReadSingleLE(out float)

Stream.TryReadUInt128BE(out UInt128)

Stream.TryReadUInt128LE(out UInt128)

Stream.TryReadUInt16BE(out ushort)

Stream.TryReadUInt16LE(out ushort)

Stream.TryReadUInt32BE(out uint)

Stream.TryReadUInt32LE(out uint)

Stream.TryReadUInt64BE(out ulong)

Stream.TryReadUInt64LE(out ulong)

Stream.TryReadUInt8(out byte)

Stream.TryReadUIntPtrBE(out nuint)

Stream.TryReadUIntPtrLE(out nuint)

Stream.TrySave(ReadOnlyNativeMemory, bool)

Stream.TrySave(ReadOnlySpan<byte>, bool)

Stream.TrySave(void*, nuint, bool)

Stream.TrySeek(long, StreamWhence, out long)

Stream.TryWrite(ReadOnlyNativeMemory, out nuint)

Stream.TryWrite(ReadOnlySpan<byte>, out int)

Stream.TryWrite(void*, nuint, out nuint)

Stream.TryWrite(string, out nuint)

Stream.TryWrite(string, out nuint, params ReadOnlySpan<object>)

Stream.TryWrite<T>(in T, out nuint)

Stream.TryWriteDoubleBE(double)

Stream.TryWriteDoubleLE(double)

Stream.TryWriteHalfBE(Half)

Stream.TryWriteHalfLE(Half)

Stream.TryWriteInt128BE(Int128)

Stream.TryWriteInt128LE(Int128)

Stream.TryWriteInt16BE(short)

Stream.TryWriteInt16LE(short)

Stream.TryWriteInt32BE(int)

Stream.TryWriteInt32LE(int)

Stream.TryWriteInt64BE(long)

Stream.TryWriteInt64LE(long)

Stream.TryWriteInt8(sbyte)

Stream.TryWriteIntPtrBE(nint)

Stream.TryWriteIntPtrLE(nint)

Stream.TryWriteSingleBE(float)

Stream.TryWriteSingleLE(float)

Stream.TryWriteUInt128BE(UInt128)

Stream.TryWriteUInt128LE(UInt128)

Stream.TryWriteUInt16BE(ushort)

Stream.TryWriteUInt16LE(ushort)

Stream.TryWriteUInt32BE(uint)

Stream.TryWriteUInt32LE(uint)

Stream.TryWriteUInt64BE(ulong)

Stream.TryWriteUInt64LE(ulong)

Stream.TryWriteUInt8(byte)

Stream.TryWriteUIntPtrBE(nuint)

Stream.TryWriteUInt128LE(nuint)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

StreamExtensions.ToClrStream(Stream, bool, bool?, bool?, bool?)

StreamExtensions.TryCopyTo(Stream, Stream, out nuint, out nuint, TimeSpan?, nuint)

StreamExtensions.TryCopyTo(Stream, Stream, out nuint, out nuint, uint?, nuint)

StreamExtensions.TryCopyTo(Stream, Stream, out nuint, out nuint, ulong?, nuint)

Remarks

Please note that operations on this stream are potentially throwing. They won't throw inevitably, but exceptions from the underlying CLR stream will propagate through this wrapper.

Constructors

ClrToSdlStream(Stream, bool)

Creates a new ClrToSdlStream instance wrapping the provided CLR Stream

public ClrToSdlStream(Stream clrStream, bool leaveOpen = false)

Parameters

clrStream Stream

The CLR Stream to wrap

leaveOpen bool

A value indicating whether to leave the underlying CLR stream open when this stream is disposed

Exceptions

ArgumentNullException

clrStream is null

Properties

ClrStream

Gets the underlying CLR Stream

public Stream? ClrStream { get; }

Property Value

Stream

The underlying CLR Stream

LengthCore

Gets the total length, in bytes, of the stream

protected override long LengthCore { get; }

Property Value

long

The total length, in bytes, of the stream, or -1 on failure

See Also

Length

Methods

CloseCore()

Closes the stream and release associated resources

protected override bool CloseCore()

Returns

bool

true if the stream was closed successfully; otherwise, false

See Also

TryClose()

Dispose(bool, bool)

Disposes the stream

protected override void Dispose(bool disposing, bool close)

Parameters

disposing bool

A value indicating whether the call came from a call to Dispose() or from the finalizer

close bool

A value indicating whether the stream should be closed

Remarks

This method is not threadsafe.

See Also

TryClose()

FlushCore(ref StreamStatus)

Flushes any buffered data in the stream

protected override bool FlushCore(ref StreamStatus status)

Parameters

status StreamStatus

The StreamStatus of the stream. The value of the referenced StreamStatus could change on failure and should not necessarily change on success.

Returns

bool

true if the flush was successful; otherwise, false

See Also

TryFlush()

ReadCore(NativeMemory, ref StreamStatus)

Reads into specified data from the stream

protected override nuint ReadCore(NativeMemory data, ref StreamStatus status)

Parameters

data NativeMemory

The memory buffer to read data into

status StreamStatus

The StreamStatus of the stream. The value of the referenced StreamStatus could change on failure and should not necessarily change on success.

Returns

nuint

The number of bytes read from the stream

See Also

TryRead(NativeMemory, out nuint)

SeekCore(long, StreamWhence)

Seeks within the stream

protected override long SeekCore(long offset, StreamWhence whence)

Parameters

offset long

The offset to seek to

whence StreamWhence

The reference point for the seek operation

Returns

long

The absolute offset from the start of the stream after seeking, or -1 on failure

See Also

TrySeek(long, StreamWhence, out long)

WriteCore(ReadOnlyNativeMemory, ref StreamStatus)

Writes all specified data into the stream

protected override nuint WriteCore(ReadOnlyNativeMemory data, ref StreamStatus status)

Parameters

data ReadOnlyNativeMemory

The memory buffer containing all the data to be written into the stream

status StreamStatus

The StreamStatus of the stream. The value of the referenced StreamStatus could change on failure and should not necessarily change on success.

Returns

nuint

The number of bytes read from the stream

See Also

TryWrite(ReadOnlyNativeMemory, out nuint)