Struct ExtensionObject 

pub struct ExtensionObject {
    pub node_id: NodeId,
    pub body: ExtensionObjectEncoding,
}

An extension object holds a serialized object identified by its node id.

Fields

node_id: NodeId

body: ExtensionObjectEncoding

Implementations

impl ExtensionObject

pub fn null() -> ExtensionObject

Creates a null extension object, i.e. one with no value or payload

pub fn is_null(&self) -> bool

Tests for null node id.

pub fn is_empty(&self) -> bool

Tests for empty body.

pub fn object_id(&self) -> Result<ObjectId, ExtensionObjectError>

Returns the object id of the thing this extension object contains, assuming the object id can be recognised from the node id.

pub fn from_encodable<N, T>(node_id: N, encodable: &T) -> ExtensionObject

where N: Into<NodeId>, T: BinaryEncoder<T>,

Creates an extension object with the specified node id and the encodable object as its payload. The body is set to a byte string containing the encoded struct.

pub fn decode_inner<T>( &self, decoding_options: &DecodingOptions, ) -> Result<T, StatusCode>

where T: BinaryEncoder<T>,

Decodes the inner content of the extension object and returns it. The node id is ignored for decoding. The caller supplies the binary encoder impl that should be used to extract the data. Errors result in a decoding error.

Trait Implementations

impl BinaryEncoder<ExtensionObject> for ExtensionObject

fn byte_len(&self) -> 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.

fn encode<S>(&self, stream: &mut S) -> Result<usize, StatusCode>

where S: Write,

Encodes the instance to the write stream.

fn decode<S>( stream: &mut S, decoding_options: &DecodingOptions, ) -> Result<ExtensionObject, StatusCode>

where S: Read,

Decodes an instance from the read stream. The decoding options contains restrictions set by the server / client on the length of strings, arrays etc. If these limits are exceeded the implementation should return with a BadDecodingError as soon as possible.

fn encode_to_vec(&self) -> Vec<u8>

impl Clone for ExtensionObject

fn clone(&self) -> ExtensionObject

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ExtensionObject

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExtensionObject

fn deserialize<__D>( __deserializer: __D, ) -> Result<ExtensionObject, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Operand> for ExtensionObject

fn from(v: &Operand) -> ExtensionObject

Converts to this type from the input type.

impl From<ExtensionObject> for Variant

fn from(v: ExtensionObject) -> Variant

Converts to this type from the input type.

impl From<Operand> for ExtensionObject

fn from(v: Operand) -> ExtensionObject

Converts to this type from the input type.

impl PartialEq for ExtensionObject

fn eq(&self, other: &ExtensionObject) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ExtensionObject

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&ExtensionObject> for Operand

type Error = StatusCode

The type returned in the event of a conversion error.

fn try_from( v: &ExtensionObject, ) -> Result<Operand, <Operand as TryFrom<&ExtensionObject>>::Error>

Performs the conversion.

impl StructuralPartialEq for ExtensionObject