MemoryStream
Overview
Memory stream implementation.
Location
- Reference: Island.fx
- Namespace: RemObjects.Elements.System
- Ancestry: Stream | MemoryStream
constructor
constructor
MemoryStream()
init()
MemoryStream()
Sub New()
constructor (Int32)
constructor(aCapacity: Int32)
MemoryStream(Int32 aCapacity)
init(_ aCapacity: Int32)
MemoryStream(Int32 aCapacity)
Sub New(aCapacity As Int32)
Parameters:
- aCapacity:
CanRead override virtual
Should return true if this stream can be read from.
property CanRead: Boolean read;
Boolean CanRead { get; }
var CanRead: Boolean { get{} }
Boolean CanRead { __get; }
ReadOnly Property CanRead() As Boolean
CanSeek override virtual
Should return true if this stream can be seeked.
property CanSeek: Boolean read;
Boolean CanSeek { get; }
var CanSeek: Boolean { get{} }
Boolean CanSeek { __get; }
ReadOnly Property CanSeek() As Boolean
CanWrite override virtual
Should return true if this stream can be written to.
property CanWrite: Boolean read;
Boolean CanWrite { get; }
var CanWrite: Boolean { get{} }
Boolean CanWrite { __get; }
ReadOnly Property CanWrite() As Boolean
Capacity
property Capacity: Int32 read write;
Int32 Capacity { get; set; }
var Capacity: Int32 { get{} set{} }
Int32 Capacity { __get; __set; }
Property Capacity() As Int32
Close virtual (declared in Stream)
method Close
void Close()
func Close()
void Close()
Sub Close()
CopyTo (declared in Stream)
method CopyTo(Destination: Stream)
void CopyTo(Stream Destination)
func CopyTo(_ Destination: Stream)
void CopyTo(Stream Destination)
Sub CopyTo(Destination As Stream)
Parameters:
- Destination:
Dispose (declared in Stream)
method Dispose
void Dispose()
func Dispose()
void Dispose()
Sub Dispose()
Equals virtual (declared in Object)
Default constructor.
method Equals(aOther: Object): Boolean
Boolean Equals(Object aOther)
func Equals(_ aOther: Object) -> Boolean
Boolean Equals(Object aOther)
Function Equals(aOther As Object) As Boolean
Parameters:
- aOther: the reference to compare this with.
Finalize protected virtual (declared in Object)
method Finalize
void Finalize()
func Finalize()
void Finalize()
Sub Finalize()
Flush virtual (declared in Stream)
method Flush
void Flush()
func Flush()
void Flush()
Sub Flush()
GetHashCode virtual (declared in Object)
Returns a hashcode for this object. Overriden implementations should make sure that the number returned here is constant given the same object.
method GetHashCode: Int32
Int32 GetHashCode()
func GetHashCode() -> Int32
Int32 GetHashCode()
Function GetHashCode() As Int32
GetType (declared in Object)
Returns the actual type of this class
method GetType: Type
Type GetType()
func GetType() -> Type
Type GetType()
Function GetType() As Type
IsValid protected override virtual
Returns true if this stream is still valid.
method IsValid: Boolean
Boolean IsValid()
func IsValid() -> Boolean
Boolean IsValid()
Function IsValid() As Boolean
Length override virtual
Length of this stream.
property Length: Int64 read;
Int64 Length { get; }
var Length: Int64 { get{} }
Int64 Length { __get; }
ReadOnly Property Length() As Int64
LoadFromFile Android, Fuchsia, iOS, iOS Simulator, Mac Catalyst, macOS, tvOS, tvOS Simulator, Ubuntu, visionOS, visionOS Simulator, watchOS, watchOS Simulator, Windows
method LoadFromFile(FileName: String)
void LoadFromFile(String FileName)
func LoadFromFile(_ FileName: String)
void LoadFromFile(String FileName)
Sub LoadFromFile(FileName As String)
Parameters:
- FileName:
Position virtual (declared in Stream)
Position in this stream.
property Position: Int64 read write;
Int64 Position { get; set; }
var Position: Int64 { get{} set{} }
Int64 Position { __get; __set; }
Property Position() As Int64
method Read(aSpan: Span<Byte>): Int32
Int32 Read(Span<Byte> aSpan)
func Read(_ aSpan: Span<Byte>) -> Int32
Int32 Read(Span<Byte> aSpan)
Function Read(aSpan As Span<Byte>) As Int32
Parameters:
- aSpan:
Read from stream into buf.
method Read(buf: ^void; Count: Int32): Int32
Int32 Read(void* buf, Int32 Count)
func Read(_ buf: UnsafeMutablePointer<void>, _ Count: Int32) -> Int32
Int32 Read(void* buf, Int32 Count)
Function Read(buf As Ptr(Of Void), Count As Int32) As Int32
Parameters:
- buf:
- Count:
Read from stream into buffer.
method Read(Buffer: array of Byte; Offset: Int32; Count: Int32): Int32
Int32 Read(Byte[] Buffer, Int32 Offset, Int32 Count)
func Read(_ Buffer: Byte..., _ Offset: Int32, _ Count: Int32) -> Int32
Int32 Read(Byte[] Buffer, Int32 Offset, Int32 Count)
Function Read(Buffer As Byte(), Offset As Int32, Count As Int32) As Int32
Parameters:
- Buffer:
- Offset:
- Count:
ReferenceEquals (declared in Object)
Compares two references for equivalence (even if they have an equals operator)
class method ReferenceEquals(a: Object; b: Object): Boolean
static Boolean ReferenceEquals(Object a, Object b)
static func ReferenceEquals(_ a: Object, _ b: Object) -> Boolean
static Boolean ReferenceEquals(Object a, Object b)
Shared Function ReferenceEquals(a As Object, b As Object) As Boolean
Parameters:
- a: left value
- b: right value
SaveToFile Android, Fuchsia, iOS, iOS Simulator, Mac Catalyst, macOS, tvOS, tvOS Simulator, Ubuntu, visionOS, visionOS Simulator, watchOS, watchOS Simulator, Windows
method SaveToFile(FileName: String)
void SaveToFile(String FileName)
func SaveToFile(_ FileName: String)
void SaveToFile(String FileName)
Sub SaveToFile(FileName As String)
Parameters:
- FileName:
Seek override virtual
Seeks this stream.
method Seek(Offset: Int64; Origin: SeekOrigin): Int64
Int64 Seek(Int64 Offset, SeekOrigin Origin)
func Seek(_ Offset: Int64, _ Origin: SeekOrigin) -> Int64
Int64 Seek(Int64 Offset, SeekOrigin Origin)
Function Seek(Offset As Int64, Origin As SeekOrigin) As Int64
Parameters:
- Offset:
- Origin:
SetLength override virtual
method SetLength(value: Int64)
void SetLength(Int64 value)
func SetLength(_ value: Int64)
void SetLength(Int64 value)
Sub SetLength(value As Int64)
Parameters:
- value:
ToArray
Gets the content of this stream as byte array.
method ToArray: array of Byte
Byte[] ToArray()
func ToArray() -> Byte...
Byte[] ToArray()
Function ToArray() As Byte()
ToString virtual (declared in Object)
Gets the string representation of this method.
method ToString: String
String ToString()
func ToString() -> String
String ToString()
Function ToString() As String
Write (ImmutableSpan<Byte>): Int32 override virtual
Writes a span to this stream.
method Write(aSpan: ImmutableSpan<Byte>): Int32
Int32 Write(ImmutableSpan<Byte> aSpan)
func Write(_ aSpan: ImmutableSpan<Byte>) -> Int32
Int32 Write(ImmutableSpan<Byte> aSpan)
Function Write(aSpan As ImmutableSpan<Byte>) As Int32
Parameters:
- aSpan:
Writes buf to a stream.
method Write(buf: ^void; Count: Int32): Int32
Int32 Write(void* buf, Int32 Count)
func Write(_ buf: UnsafeMutablePointer<void>, _ Count: Int32) -> Int32
Int32 Write(void* buf, Int32 Count)
Function Write(buf As Ptr(Of Void), Count As Int32) As Int32
Parameters:
- buf:
- Count:
Writes a byte array to this stream.
method Write(Buffer: array of Byte; Offset: Int32; Count: Int32): Int32
Int32 Write(Byte[] Buffer, Int32 Offset, Int32 Count)
func Write(_ Buffer: Byte..., _ Offset: Int32, _ Count: Int32) -> Int32
Int32 Write(Byte[] Buffer, Int32 Offset, Int32 Count)
Function Write(Buffer As Byte(), Offset As Int32, Count As Int32) As Int32
Parameters:
- Buffer:
- Offset:
- Count:
WriteTo
method WriteTo(Destination: Stream)
void WriteTo(Stream Destination)
func WriteTo(_ Destination: Stream)
void WriteTo(Stream Destination)
Sub WriteTo(Destination As Stream)
Parameters:
- Destination:
CanRead override virtual
Should return true if this stream can be read from.
property CanRead: Boolean read;
Boolean CanRead { get; }
var CanRead: Boolean { get{} }
Boolean CanRead { __get; }
ReadOnly Property CanRead() As Boolean
CanSeek override virtual
Should return true if this stream can be seeked.
property CanSeek: Boolean read;
Boolean CanSeek { get; }
var CanSeek: Boolean { get{} }
Boolean CanSeek { __get; }
ReadOnly Property CanSeek() As Boolean
CanWrite override virtual
Should return true if this stream can be written to.
property CanWrite: Boolean read;
Boolean CanWrite { get; }
var CanWrite: Boolean { get{} }
Boolean CanWrite { __get; }
ReadOnly Property CanWrite() As Boolean
Capacity
property Capacity: Int32 read write;
Int32 Capacity { get; set; }
var Capacity: Int32 { get{} set{} }
Int32 Capacity { __get; __set; }
Property Capacity() As Int32
Length override virtual
Length of this stream.
property Length: Int64 read;
Int64 Length { get; }
var Length: Int64 { get{} }
Int64 Length { __get; }
ReadOnly Property Length() As Int64
Position virtual (declared in Stream)
Position in this stream.
property Position: Int64 read write;
Int64 Position { get; set; }
var Position: Int64 { get{} set{} }
Int64 Position { __get; __set; }
Property Position() As Int64
ReferenceEquals (declared in Object)
Compares two references for equivalence (even if they have an equals operator)
class method ReferenceEquals(a: Object; b: Object): Boolean
static Boolean ReferenceEquals(Object a, Object b)
static func ReferenceEquals(_ a: Object, _ b: Object) -> Boolean
static Boolean ReferenceEquals(Object a, Object b)
Shared Function ReferenceEquals(a As Object, b As Object) As Boolean
Parameters:
- a: left value
- b: right value
constructor
constructor
MemoryStream()
init()
MemoryStream()
Sub New()
constructor (Int32)
constructor(aCapacity: Int32)
MemoryStream(Int32 aCapacity)
init(_ aCapacity: Int32)
MemoryStream(Int32 aCapacity)
Sub New(aCapacity As Int32)
Parameters:
- aCapacity:
Close virtual (declared in Stream)
method Close
void Close()
func Close()
void Close()
Sub Close()
CopyTo (declared in Stream)
method CopyTo(Destination: Stream)
void CopyTo(Stream Destination)
func CopyTo(_ Destination: Stream)
void CopyTo(Stream Destination)
Sub CopyTo(Destination As Stream)
Parameters:
- Destination:
Dispose (declared in Stream)
method Dispose
void Dispose()
func Dispose()
void Dispose()
Sub Dispose()
Equals virtual (declared in Object)
Default constructor.
method Equals(aOther: Object): Boolean
Boolean Equals(Object aOther)
func Equals(_ aOther: Object) -> Boolean
Boolean Equals(Object aOther)
Function Equals(aOther As Object) As Boolean
Parameters:
- aOther: the reference to compare this with.
Finalize protected virtual (declared in Object)
method Finalize
void Finalize()
func Finalize()
void Finalize()
Sub Finalize()
Flush virtual (declared in Stream)
method Flush
void Flush()
func Flush()
void Flush()
Sub Flush()
GetHashCode virtual (declared in Object)
Returns a hashcode for this object. Overriden implementations should make sure that the number returned here is constant given the same object.
method GetHashCode: Int32
Int32 GetHashCode()
func GetHashCode() -> Int32
Int32 GetHashCode()
Function GetHashCode() As Int32
GetType (declared in Object)
Returns the actual type of this class
method GetType: Type
Type GetType()
func GetType() -> Type
Type GetType()
Function GetType() As Type
IsValid protected override virtual
Returns true if this stream is still valid.
method IsValid: Boolean
Boolean IsValid()
func IsValid() -> Boolean
Boolean IsValid()
Function IsValid() As Boolean
LoadFromFile Android, Fuchsia, iOS, iOS Simulator, Mac Catalyst, macOS, tvOS, tvOS Simulator, Ubuntu, visionOS, visionOS Simulator, watchOS, watchOS Simulator, Windows
method LoadFromFile(FileName: String)
void LoadFromFile(String FileName)
func LoadFromFile(_ FileName: String)
void LoadFromFile(String FileName)
Sub LoadFromFile(FileName As String)
Parameters:
- FileName:
method Read(aSpan: Span<Byte>): Int32
Int32 Read(Span<Byte> aSpan)
func Read(_ aSpan: Span<Byte>) -> Int32
Int32 Read(Span<Byte> aSpan)
Function Read(aSpan As Span<Byte>) As Int32
Parameters:
- aSpan:
Read from stream into buf.
method Read(buf: ^void; Count: Int32): Int32
Int32 Read(void* buf, Int32 Count)
func Read(_ buf: UnsafeMutablePointer<void>, _ Count: Int32) -> Int32
Int32 Read(void* buf, Int32 Count)
Function Read(buf As Ptr(Of Void), Count As Int32) As Int32
Parameters:
- buf:
- Count:
Read from stream into buffer.
method Read(Buffer: array of Byte; Offset: Int32; Count: Int32): Int32
Int32 Read(Byte[] Buffer, Int32 Offset, Int32 Count)
func Read(_ Buffer: Byte..., _ Offset: Int32, _ Count: Int32) -> Int32
Int32 Read(Byte[] Buffer, Int32 Offset, Int32 Count)
Function Read(Buffer As Byte(), Offset As Int32, Count As Int32) As Int32
Parameters:
- Buffer:
- Offset:
- Count:
SaveToFile Android, Fuchsia, iOS, iOS Simulator, Mac Catalyst, macOS, tvOS, tvOS Simulator, Ubuntu, visionOS, visionOS Simulator, watchOS, watchOS Simulator, Windows
method SaveToFile(FileName: String)
void SaveToFile(String FileName)
func SaveToFile(_ FileName: String)
void SaveToFile(String FileName)
Sub SaveToFile(FileName As String)
Parameters:
- FileName:
Seek override virtual
Seeks this stream.
method Seek(Offset: Int64; Origin: SeekOrigin): Int64
Int64 Seek(Int64 Offset, SeekOrigin Origin)
func Seek(_ Offset: Int64, _ Origin: SeekOrigin) -> Int64
Int64 Seek(Int64 Offset, SeekOrigin Origin)
Function Seek(Offset As Int64, Origin As SeekOrigin) As Int64
Parameters:
- Offset:
- Origin:
SetLength override virtual
method SetLength(value: Int64)
void SetLength(Int64 value)
func SetLength(_ value: Int64)
void SetLength(Int64 value)
Sub SetLength(value As Int64)
Parameters:
- value:
ToArray
Gets the content of this stream as byte array.
method ToArray: array of Byte
Byte[] ToArray()
func ToArray() -> Byte...
Byte[] ToArray()
Function ToArray() As Byte()
ToString virtual (declared in Object)
Gets the string representation of this method.
method ToString: String
String ToString()
func ToString() -> String
String ToString()
Function ToString() As String
Write (ImmutableSpan<Byte>): Int32 override virtual
Writes a span to this stream.
method Write(aSpan: ImmutableSpan<Byte>): Int32
Int32 Write(ImmutableSpan<Byte> aSpan)
func Write(_ aSpan: ImmutableSpan<Byte>) -> Int32
Int32 Write(ImmutableSpan<Byte> aSpan)
Function Write(aSpan As ImmutableSpan<Byte>) As Int32
Parameters:
- aSpan:
Writes buf to a stream.
method Write(buf: ^void; Count: Int32): Int32
Int32 Write(void* buf, Int32 Count)
func Write(_ buf: UnsafeMutablePointer<void>, _ Count: Int32) -> Int32
Int32 Write(void* buf, Int32 Count)
Function Write(buf As Ptr(Of Void), Count As Int32) As Int32
Parameters:
- buf:
- Count:
Writes a byte array to this stream.
method Write(Buffer: array of Byte; Offset: Int32; Count: Int32): Int32
Int32 Write(Byte[] Buffer, Int32 Offset, Int32 Count)
func Write(_ Buffer: Byte..., _ Offset: Int32, _ Count: Int32) -> Int32
Int32 Write(Byte[] Buffer, Int32 Offset, Int32 Count)
Function Write(Buffer As Byte(), Offset As Int32, Count As Int32) As Int32
Parameters:
- Buffer:
- Offset:
- Count:
WriteTo
method WriteTo(Destination: Stream)
void WriteTo(Stream Destination)
func WriteTo(_ Destination: Stream)
void WriteTo(Stream Destination)
Sub WriteTo(Destination As Stream)
Parameters:
- Destination: