Trait BinaryEncodable

Source

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

    // 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>(&self, stream: &mut S, ctx: &Context<'_>) -> Result<(), Error>
where S: Write + ?Sized,

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", so this trait is not object safe.

Trait BinaryEncodable Copy item path

§Implementing

Required Methods§

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

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

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>(&self, stream: &mut S, ctx: &Context<'_>) -> Result<(), Error>where S: Write + ?Sized,

Implementors§

impl BinaryEncodable for RequestMessage

impl BinaryEncodable for ResponseMessage

impl BinaryEncodable for ActionState

impl BinaryEncodable for ApplicationType

impl BinaryEncodable for AxisScaleEnumeration

impl BinaryEncodable for BrokerTransportQualityOfService

impl BinaryEncodable for BrowseDirection

impl BinaryEncodable for BrowseResultMask

impl BinaryEncodable for ChassisIdSubtype

impl BinaryEncodable for ConversionLimitEnum

impl BinaryEncodable for DataChangeTrigger

impl BinaryEncodable for DataSetOrderingType

impl BinaryEncodable for DeadbandType

impl BinaryEncodable for DiagnosticsLevel

impl BinaryEncodable for Duplex

impl BinaryEncodable for ExceptionDeviationFormat

impl BinaryEncodable for FilterOperator

impl BinaryEncodable for HistoryUpdateType

impl BinaryEncodable for IdType

impl BinaryEncodable for IdentityCriteriaType

impl BinaryEncodable for InterfaceAdminStatus

impl BinaryEncodable for InterfaceOperStatus

impl BinaryEncodable for ManAddrIfSubtype

impl BinaryEncodable for MessageSecurityMode

impl BinaryEncodable for ModelChangeStructureVerbMask

impl BinaryEncodable for MonitoringMode

impl BinaryEncodable for NamingRuleType

impl BinaryEncodable for NegotiationStatus

impl BinaryEncodable for NodeAttributesMask

impl BinaryEncodable for NodeClass

impl BinaryEncodable for OpenFileMode

impl BinaryEncodable for OverrideValueHandling

impl BinaryEncodable for PerformUpdateType

impl BinaryEncodable for PortIdSubtype

impl BinaryEncodable for PubSubDiagnosticsCounterClassification

impl BinaryEncodable for PubSubState

impl BinaryEncodable for RedundancySupport

impl BinaryEncodable for RedundantServerMode

impl BinaryEncodable for SecurityTokenRequestType

impl BinaryEncodable for ServerState

impl BinaryEncodable for SortOrderType

impl BinaryEncodable for StructureType

impl BinaryEncodable for TimestampsToReturn

impl BinaryEncodable for TrustListMasks

impl BinaryEncodable for TsnFailureCode

impl BinaryEncodable for TsnListenerStatus

impl BinaryEncodable for TsnStreamState

impl BinaryEncodable for TsnTalkerStatus

impl BinaryEncodable for UserTokenType

impl BinaryEncodable for Variant

impl BinaryEncodable for DynamicStructure

impl BinaryEncodable for ActionMethodDataType

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

Trait BinaryEncodable

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

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

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