Binary
Overview
Binary is a holder class for binary data. Generally just wraps the platform type for binary data, like NSData or Stream.
Location
-
Reference:
- Elements.dll .NET, .NET Core 6.0, .NET Standard 2.0
- elements.jar Cooper
- Elements.fx Island, ToffeeV2
- libElements.fx Toffee
- Namespace: RemObjects.Elements.RTL
-
Mapped to:
- MemoryStream .NET, .NET Core 6.0, .NET Standard 2.0
- MemoryStream Island
- NSMutableData Toffee, ToffeeV2
- Ancestry: ImmutableBinary | Binary
constructor (array of Byte)
Creates a new binary with the data as input.
constructor(aArray: array of Byte)
Binary(Byte[] aArray)
init(_ aArray: Byte...)
Binary(Byte[] aArray)
Sub New(aArray As Byte())
Parameters:
- aArray:
constructor (not nullable array of Byte, Int32) (declared in ImmutableBinary)
constructor(aArray: not nullable array of Byte; aCount: Int32)
Binary(Byte[]! aArray, Int32 aCount)
init(_ aArray: Byte..., _ aCount: Int32)
Binary(Byte[] aArray, Integer aCount)
Sub New(aArray As Byte(), aCount As Int32)
Parameters:
- aArray:
- aCount:
constructor (not nullable array of Byte, Int32, Int32) (declared in ImmutableBinary)
constructor(aArray: not nullable array of Byte; aOffset: Int32; aCount: Int32)
Binary(Byte[]! aArray, Int32 aOffset, Int32 aCount)
init(_ aArray: Byte..., _ aOffset: Int32, _ aCount: Int32)
Binary(Byte[] aArray, Integer aOffset, Integer aCount)
Sub New(aArray As Byte(), aOffset As Int32, aCount As Int32)
Parameters:
- aArray:
- aOffset:
- aCount:
constructor (not nullable NSData) (declared in ImmutableBinary) Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32
constructor(aData: not nullable NSData)
Binary(NSData! aData)
init(_ aData: NSData)
Sub New(aData As NSData)
Parameters:
- aData:
Assign
Sets the value of this binary.
method Assign(Bin: ImmutableBinary)
void Assign(ImmutableBinary Bin)
func Assign(_ Bin: ImmutableBinary)
void Assign(ImmutableBinary Bin)
Sub Assign(Bin As ImmutableBinary)
Parameters:
- Bin:
Clear
Clear the binary.
method Clear
void Clear()
func Clear()
void Clear()
Sub Clear()
IndexOf (declared in ImmutableBinary)
method IndexOf(aBytes: array of Byte): Int32
Int32 IndexOf(Byte[] aBytes)
func IndexOf(_ aBytes: Byte...) -> Int32
Integer IndexOf(Byte[] aBytes)
Function IndexOf(aBytes As Byte()) As Int32
Parameters:
- aBytes:
Length (declared in ImmutableBinary)
Returns the length of this binary.
property Length: Int32 read;
Int32 Length { get; }
var Length: Int32 { get{} }
Integer Length { __get; }
ReadOnly Property Length() As Int32
MutableVersion (declared in ImmutableBinary)
Creates a copy of this and make it mutable.
method MutableVersion: not nullable Binary
Binary! MutableVersion()
func MutableVersion() -> Binary
Binary MutableVersion()
Function MutableVersion() As Binary
Read (Int32, Int32): array of Byte (declared in ImmutableBinary)
Read the content of this binary into an array.
method Read(aStartIndex: Int32; aCount: Int32): array of Byte
Byte[] Read(Int32 aStartIndex, Int32 aCount)
func Read(_ aStartIndex: Int32, _ aCount: Int32) -> Byte...
Byte[] Read(Integer aStartIndex, Integer aCount)
Function Read(aStartIndex As Int32, aCount As Int32) As Byte()
Parameters:
- aStartIndex:
- aCount:
Read (Int32): array of Byte (declared in ImmutableBinary)
Read the content of this binary into an array.
method Read(Count: Int32): array of Byte
Byte[] Read(Int32 Count)
func Read(_ Count: Int32) -> Byte...
Byte[] Read(Integer Count)
Function Read(Count As Int32) As Byte()
Parameters:
- Count:
Read (Range): array of Byte (declared in ImmutableBinary)
Read the content of this binary into an array.
method Read(Range: Range): array of Byte
Byte[] Read(Range Range)
func Read(_ Range: Range) -> Byte...
Byte[] Read(Range Range)
Function Read(Range As Range) As Byte()
Parameters:
- Range:
Subdata (Int32, Int32): Binary (declared in ImmutableBinary)
Read the content of this binary into an array.
method Subdata(aStartIndex: Int32; aCount: Int32): Binary
Binary Subdata(Int32 aStartIndex, Int32 aCount)
func Subdata(_ aStartIndex: Int32, _ aCount: Int32) -> Binary
Binary Subdata(Integer aStartIndex, Integer aCount)
Function Subdata(aStartIndex As Int32, aCount As Int32) As Binary
Parameters:
- aStartIndex:
- aCount:
Subdata (Range): Binary (declared in ImmutableBinary)
Read the content of this binary into an array.
method Subdata(Range: Range): Binary
Binary Subdata(Range Range)
func Subdata(_ Range: Range) -> Binary
Binary Subdata(Range Range)
Function Subdata(Range As Range) As Binary
Parameters:
- Range:
ToArray (declared in ImmutableBinary)
Get the content of this binary as array.
method ToArray: not nullable array of Byte
Byte[]! ToArray()
func ToArray() -> Byte...
Byte[] ToArray()
Function ToArray() As Byte()
ToNSMutableData (declared in ImmutableBinary) Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32
method ToNSMutableData: NSMutableData
NSMutableData ToNSMutableData()
func ToNSMutableData() -> NSMutableData
Function ToNSMutableData() As NSMutableData
ToPlatformBinary (declared in ImmutableBinary) Cooper
Get the underlying storage.
method ToPlatformBinary: ImmutablePlatformBinary
ImmutablePlatformBinary ToPlatformBinary()
func ToPlatformBinary() -> ImmutablePlatformBinary
ImmutablePlatformBinary ToPlatformBinary()
Function ToPlatformBinary() As ImmutablePlatformBinary
Write (Binary)
Append data to the end of this binary.
method Write(Bin: Binary)
void Write(Binary Bin)
func Write(_ Bin: Binary)
void Write(Binary Bin)
Sub Write(Bin As Binary)
Parameters:
- Bin:
Write (array of Byte)
Append data to the end of this binary.
method Write(Buffer: array of Byte)
void Write(Byte[] Buffer)
func Write(_ Buffer: Byte...)
void Write(Byte[] Buffer)
Sub Write(Buffer As Byte())
Parameters:
- Buffer:
Append data to the end of this binary.
method Write(Buffer: array of Byte; Count: Int32)
void Write(Byte[] Buffer, Int32 Count)
func Write(_ Buffer: Byte..., _ Count: Int32)
void Write(Byte[] Buffer, Integer Count)
Sub Write(Buffer As Byte(), Count As Int32)
Parameters:
- Buffer:
- Count:
Append data to the end of this binary.
method Write(Buffer: array of Byte; Offset: Int32; Count: Int32)
void Write(Byte[] Buffer, Int32 Offset, Int32 Count)
func Write(_ Buffer: Byte..., _ Offset: Int32, _ Count: Int32)
void Write(Byte[] Buffer, Integer Offset, Integer Count)
Sub Write(Buffer As Byte(), Offset As Int32, Count As Int32)
Parameters:
- Buffer:
- Offset:
- Count:
Length (declared in ImmutableBinary)
Returns the length of this binary.
property Length: Int32 read;
Int32 Length { get; }
var Length: Int32 { get{} }
Integer Length { __get; }
ReadOnly Property Length() As Int32
constructor (array of Byte)
Creates a new binary with the data as input.
constructor(aArray: array of Byte)
Binary(Byte[] aArray)
init(_ aArray: Byte...)
Binary(Byte[] aArray)
Sub New(aArray As Byte())
Parameters:
- aArray:
constructor (not nullable array of Byte, Int32) (declared in ImmutableBinary)
constructor(aArray: not nullable array of Byte; aCount: Int32)
Binary(Byte[]! aArray, Int32 aCount)
init(_ aArray: Byte..., _ aCount: Int32)
Binary(Byte[] aArray, Integer aCount)
Sub New(aArray As Byte(), aCount As Int32)
Parameters:
- aArray:
- aCount:
constructor (not nullable array of Byte, Int32, Int32) (declared in ImmutableBinary)
constructor(aArray: not nullable array of Byte; aOffset: Int32; aCount: Int32)
Binary(Byte[]! aArray, Int32 aOffset, Int32 aCount)
init(_ aArray: Byte..., _ aOffset: Int32, _ aCount: Int32)
Binary(Byte[] aArray, Integer aOffset, Integer aCount)
Sub New(aArray As Byte(), aOffset As Int32, aCount As Int32)
Parameters:
- aArray:
- aOffset:
- aCount:
constructor (not nullable NSData) (declared in ImmutableBinary) Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32
constructor(aData: not nullable NSData)
Binary(NSData! aData)
init(_ aData: NSData)
Sub New(aData As NSData)
Parameters:
- aData:
Assign
Sets the value of this binary.
method Assign(Bin: ImmutableBinary)
void Assign(ImmutableBinary Bin)
func Assign(_ Bin: ImmutableBinary)
void Assign(ImmutableBinary Bin)
Sub Assign(Bin As ImmutableBinary)
Parameters:
- Bin:
Clear
Clear the binary.
method Clear
void Clear()
func Clear()
void Clear()
Sub Clear()
IndexOf (declared in ImmutableBinary)
method IndexOf(aBytes: array of Byte): Int32
Int32 IndexOf(Byte[] aBytes)
func IndexOf(_ aBytes: Byte...) -> Int32
Integer IndexOf(Byte[] aBytes)
Function IndexOf(aBytes As Byte()) As Int32
Parameters:
- aBytes:
MutableVersion (declared in ImmutableBinary)
Creates a copy of this and make it mutable.
method MutableVersion: not nullable Binary
Binary! MutableVersion()
func MutableVersion() -> Binary
Binary MutableVersion()
Function MutableVersion() As Binary
Read (Int32, Int32): array of Byte (declared in ImmutableBinary)
Read the content of this binary into an array.
method Read(aStartIndex: Int32; aCount: Int32): array of Byte
Byte[] Read(Int32 aStartIndex, Int32 aCount)
func Read(_ aStartIndex: Int32, _ aCount: Int32) -> Byte...
Byte[] Read(Integer aStartIndex, Integer aCount)
Function Read(aStartIndex As Int32, aCount As Int32) As Byte()
Parameters:
- aStartIndex:
- aCount:
Read (Int32): array of Byte (declared in ImmutableBinary)
Read the content of this binary into an array.
method Read(Count: Int32): array of Byte
Byte[] Read(Int32 Count)
func Read(_ Count: Int32) -> Byte...
Byte[] Read(Integer Count)
Function Read(Count As Int32) As Byte()
Parameters:
- Count:
Read (Range): array of Byte (declared in ImmutableBinary)
Read the content of this binary into an array.
method Read(Range: Range): array of Byte
Byte[] Read(Range Range)
func Read(_ Range: Range) -> Byte...
Byte[] Read(Range Range)
Function Read(Range As Range) As Byte()
Parameters:
- Range:
Subdata (Int32, Int32): Binary (declared in ImmutableBinary)
Read the content of this binary into an array.
method Subdata(aStartIndex: Int32; aCount: Int32): Binary
Binary Subdata(Int32 aStartIndex, Int32 aCount)
func Subdata(_ aStartIndex: Int32, _ aCount: Int32) -> Binary
Binary Subdata(Integer aStartIndex, Integer aCount)
Function Subdata(aStartIndex As Int32, aCount As Int32) As Binary
Parameters:
- aStartIndex:
- aCount:
Subdata (Range): Binary (declared in ImmutableBinary)
Read the content of this binary into an array.
method Subdata(Range: Range): Binary
Binary Subdata(Range Range)
func Subdata(_ Range: Range) -> Binary
Binary Subdata(Range Range)
Function Subdata(Range As Range) As Binary
Parameters:
- Range:
ToArray (declared in ImmutableBinary)
Get the content of this binary as array.
method ToArray: not nullable array of Byte
Byte[]! ToArray()
func ToArray() -> Byte...
Byte[] ToArray()
Function ToArray() As Byte()
ToNSMutableData (declared in ImmutableBinary) Island-iOS Simulator, Island-iOS-arm64, Island-Mac Catalyst, Island-macOS, Island-tvOS Simulator, Island-tvOS-arm64, Island-visionOS Simulator, Island-visionOS-arm64, Island-watchOS Simulator, Island-watchOS-arm64_32
method ToNSMutableData: NSMutableData
NSMutableData ToNSMutableData()
func ToNSMutableData() -> NSMutableData
Function ToNSMutableData() As NSMutableData
ToPlatformBinary (declared in ImmutableBinary) Cooper
Get the underlying storage.
method ToPlatformBinary: ImmutablePlatformBinary
ImmutablePlatformBinary ToPlatformBinary()
func ToPlatformBinary() -> ImmutablePlatformBinary
ImmutablePlatformBinary ToPlatformBinary()
Function ToPlatformBinary() As ImmutablePlatformBinary
Write (Binary)
Append data to the end of this binary.
method Write(Bin: Binary)
void Write(Binary Bin)
func Write(_ Bin: Binary)
void Write(Binary Bin)
Sub Write(Bin As Binary)
Parameters:
- Bin:
Write (array of Byte)
Append data to the end of this binary.
method Write(Buffer: array of Byte)
void Write(Byte[] Buffer)
func Write(_ Buffer: Byte...)
void Write(Byte[] Buffer)
Sub Write(Buffer As Byte())
Parameters:
- Buffer:
Append data to the end of this binary.
method Write(Buffer: array of Byte; Count: Int32)
void Write(Byte[] Buffer, Int32 Count)
func Write(_ Buffer: Byte..., _ Count: Int32)
void Write(Byte[] Buffer, Integer Count)
Sub Write(Buffer As Byte(), Count As Int32)
Parameters:
- Buffer:
- Count:
Append data to the end of this binary.
method Write(Buffer: array of Byte; Offset: Int32; Count: Int32)
void Write(Byte[] Buffer, Int32 Offset, Int32 Count)
func Write(_ Buffer: Byte..., _ Offset: Int32, _ Count: Int32)
void Write(Byte[] Buffer, Integer Offset, Integer Count)
Sub Write(Buffer As Byte(), Offset As Int32, Count As Int32)
Parameters:
- Buffer:
- Offset:
- Count: