Class BinaryDataWrapper

Namespace

CMS.Core

Assembly

CMS.Core.dll

Wrapper for the binary data (fox example for the web farm tasks).

public class BinaryDataWrapper

Inheritance

object

BinaryDataWrapper

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

BinaryDataWrapper(byte[])

Constructor

public BinaryDataWrapper(byte[] data)

Parameters

data byte[]

Source data

BinaryDataWrapper(Func<byte[]>)

Constructor

public BinaryDataWrapper(Func<byte[]> getData)

Parameters

getData Func<byte[]>

Method used to get the binary data when required

BinaryDataWrapper(Stream)

Constructor

public BinaryDataWrapper(Stream str)

Parameters

str Stream

Source stream

Fields

mData

Resulting binary data

protected byte[] mData

Field Value

byte[]

mStream

Resulting stream

protected Stream mStream

Field Value

Stream

Properties

Data

Resulting binary data

public byte[] Data { get; }

Property Value

byte[]

GetData

External method used to get the binary data when required

protected Func<byte[]> GetData { get; set; }

Property Value

Func<byte[]>

IsLoaded

True if data were loaded to memory.

public bool IsLoaded { get; }

Property Value

bool

Length

Length of the binary data

public long Length { get; }

Property Value

long

SourceData

Source data

protected byte[] SourceData { get; set; }

Property Value

byte[]

SourceStream

Source stream

public Stream SourceStream { get; protected set; }

Property Value

Stream

Stream

Returns SourceStream if not null, otherwise returns SourceData wrapped in the MemoryStream.

public Stream Stream { get; }

Property Value

Stream

Methods

Close()

Closes the stream behind this binary data (if set)

public void Close()

GetByteArrayFromStream(Stream, int, long)

Returns byte array from input stream.

public static byte[] GetByteArrayFromStream(Stream stream, int bufferSize = 65536, long position = 0)

Parameters

stream Stream

Input stream

bufferSize int

Buffer size, by default 64kB

position long

Position from which the reading should start

Returns

byte[]

Operators

implicit operator BinaryDataWrapper(byte[])

Implicit operator to convert byte array to task binary data

public static implicit operator BinaryDataWrapper(byte[] data)

Parameters

data byte[]

Source data

Returns

BinaryDataWrapper

implicit operator BinaryDataWrapper(Stream)

Implicit operator to convert stream to task binary data

public static implicit operator BinaryDataWrapper(Stream str)

Parameters

str Stream

Source stream

Returns

BinaryDataWrapper