Trait BinaryEncodable

Source

pub trait BinaryEncodable {
    // Required methods
    fn byte_len(&self, ctx: &Context<'_>) -> usize;
    fn encode<S: Write + ?Sized>(
        &self,
        stream: &mut S,
        ctx: &Context<'_>,
    ) -> EncodingResult<()>;

    // Provided methods
    fn override_encoding(&self) -> Option<BuiltInDataEncoding> { ... }
    fn encode_to_vec(&self, ctx: &Context<'_>) -> Vec<u8> ⓘ { ... }
}

Expand description

OPC UA Binary Encoding interface. Anything that encodes to binary must implement this. It provides functions to calculate the size in bytes of the struct (for allocating memory), encoding to a stream and decoding from a stream.

§Implementing

The majority of implementers should just use the derive(BinaryEncodable) macro, if you need to implement this yourself for some reason, the following must be satisfied:

byte_len must return a length exactly equal to what encode will write, or encode must be guaranteed to fail. Since byte_len is infallible, you are allowed to return some invalid value there, then fail later when calling encode. This should be avoided.
encode must use write_all on the stream, not just write, to ensure that all the data is written, even if the stream is interrupted. Prefer calling encode on inner types instead.

Required Methods§

Source

fn byte_len(&self, ctx: &Context<'_>) -> usize

Returns the exact byte length of the structure as it would be if encode were called. This may be called prior to writing to ensure the correct amount of space is available.

Source

fn encode<S: Write + ?Sized>( &self, stream: &mut S, ctx: &Context<'_>, ) -> EncodingResult<()>

Encodes the instance to the write stream.

Provided Methods§

Source

fn override_encoding(&self) -> Option<BuiltInDataEncoding>

Override the extension object encoding used for this type. This only makes sense if the type can only ever be encoded using a single built-in encoding.

Source

fn encode_to_vec(&self, ctx: &Context<'_>) -> Vec<u8> ⓘ

Convenience method for encoding a message straight into an array of bytes. It is preferable to reuse buffers than to call this so it should be reserved for tests and trivial code.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Trait BinaryEncodable Copy item path

§Implementing

Required Methods§

fn byte_len(&self, ctx: &Context<'_>) -> usize

fn encode<S: Write + ?Sized>( &self, stream: &mut S, ctx: &Context<'_>, ) -> EncodingResult<()>

Provided Methods§

fn override_encoding(&self) -> Option<BuiltInDataEncoding>

fn encode_to_vec(&self, ctx: &Context<'_>) -> Vec<u8> ⓘ

Dyn Compatibility§

Implementations on Foreign Types§

impl<T> BinaryEncodable for Option<Vec<T>>where T: BinaryEncodable,

fn byte_len(&self, ctx: &Context<'_>) -> usize

fn encode<S: Write + ?Sized>( &self, stream: &mut S, ctx: &Context<'_>, ) -> EncodingResult<()>

Implementors§

impl BinaryEncodable for ActionMethodDataType

impl BinaryEncodable for ActionState

impl BinaryEncodable for ActionTargetDataType

impl BinaryEncodable for ActivateSessionRequest

impl BinaryEncodable for ActivateSessionResponse

impl BinaryEncodable for AddNodesItem

impl BinaryEncodable for AddNodesRequest

impl BinaryEncodable for AddNodesResponse

impl BinaryEncodable for AddNodesResult

impl BinaryEncodable for AddReferencesItem

impl BinaryEncodable for AddReferencesRequest

impl BinaryEncodable for AddReferencesResponse

impl BinaryEncodable for AdditionalParametersType

impl BinaryEncodable for AggregateConfiguration

impl BinaryEncodable for AggregateFilter

impl BinaryEncodable for AggregateFilterResult

impl BinaryEncodable for AliasNameDataType

impl BinaryEncodable for Annotation

impl BinaryEncodable for AnnotationDataType

impl BinaryEncodable for AnonymousIdentityToken

impl BinaryEncodable for ApplicationDescription

impl BinaryEncodable for ApplicationType

impl BinaryEncodable for Argument

impl BinaryEncodable for AttributeOperand

impl BinaryEncodable for AxisInformation

impl BinaryEncodable for AxisScaleEnumeration

impl BinaryEncodable for BitFieldDefinition

impl BinaryEncodable for BrokerConnectionTransportDataType

impl BinaryEncodable for BrokerDataSetReaderTransportDataType

impl BinaryEncodable for BrokerDataSetWriterTransportDataType

impl BinaryEncodable for BrokerTransportQualityOfService

impl BinaryEncodable for BrokerWriterGroupTransportDataType

impl BinaryEncodable for BrowseDescription

impl BinaryEncodable for BrowseDirection

impl BinaryEncodable for BrowseNextRequest

impl BinaryEncodable for BrowseNextResponse

impl BinaryEncodable for BrowsePath

impl BinaryEncodable for BrowsePathResult

impl BinaryEncodable for BrowsePathTarget

impl BinaryEncodable for BrowseRequest

impl BinaryEncodable for BrowseResponse

impl BinaryEncodable for BrowseResult

impl BinaryEncodable for BrowseResultMask

impl BinaryEncodable for BuildInfo

impl BinaryEncodable for ByteStringBody

impl BinaryEncodable for CallMethodRequest

impl BinaryEncodable for CallMethodResult

impl BinaryEncodable for CallRequest

impl BinaryEncodable for CallResponse

impl BinaryEncodable for CancelRequest

impl BinaryEncodable for CancelResponse

impl BinaryEncodable for ChannelSecurityToken

impl BinaryEncodable for ChassisIdSubtype

impl BinaryEncodable for CloseSecureChannelRequest

impl BinaryEncodable for CloseSecureChannelResponse

impl BinaryEncodable for CloseSessionRequest

impl BinaryEncodable for CloseSessionResponse

impl BinaryEncodable for ComplexNumberType

impl BinaryEncodable for ConfigurationVersionDataType

impl BinaryEncodable for ContentFilter

impl BinaryEncodable for ContentFilterElement

impl BinaryEncodable for ContentFilterElementResult

impl BinaryEncodable for ContentFilterResult

impl BinaryEncodable for ConversionLimitEnum

impl BinaryEncodable for CreateMonitoredItemsRequest

impl BinaryEncodable for CreateMonitoredItemsResponse

Trait BinaryEncodable

impl<T> BinaryEncodable for Option<Vec<T>>
where T: BinaryEncodable,