Struct ResponseHeader 

pub struct ResponseHeader {
    pub timestamp: UtcTime,
    pub request_handle: IntegerId,
    pub service_result: StatusCode,
    pub service_diagnostics: DiagnosticInfo,
    pub string_table: Option<Vec<UAString>>,
    pub additional_header: ExtensionObject,
}

The ResponseHeader contains information common to every response from server to client.

Fields

timestamp: UtcTime

Response timestamp.

request_handle: IntegerId

Handle of the request this message is responding to.

service_result: StatusCode

Status of the service call as a whole.

service_diagnostics: DiagnosticInfo

Requested diagnostics.

string_table: Option<Vec<UAString>>

String table for the message.

additional_header: ExtensionObject

Reserved space for additional header details.

Implementations

impl ResponseHeader

pub fn new_good(request_header: impl AsRequestHandle) -> ResponseHeader

Create a new response header with status Good.

pub fn new_service_result( request_header: impl AsRequestHandle, service_result: StatusCode, ) -> ResponseHeader

Create a new response header with given status.

pub fn new_timestamped_service_result( timestamp: DateTime, request_header: impl AsRequestHandle, service_result: StatusCode, ) -> ResponseHeader

Create a new response header with given status and timestamp.

pub fn null() -> ResponseHeader

For testing, nothing else

Trait Implementations

impl BinaryDecodable for ResponseHeader

fn decode<S: Read + ?Sized>( stream: &mut S, ctx: &Context<'_>, ) -> EncodingResult<Self>

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.

impl BinaryEncodable for ResponseHeader

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.

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

Encodes the instance to the write stream.

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.

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.

impl Clone for ResponseHeader

fn clone(&self) -> ResponseHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseHeader

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

Formats the value using the given formatter.

impl Default for ResponseHeader

fn default() -> ResponseHeader

Returns the “default value” for a type.

impl JsonDecodable for ResponseHeader

fn decode( stream: &mut JsonStreamReader<&mut dyn Read>, ctx: &Context<'_>, ) -> EncodingResult<Self>

Decode Self from a JSON stream.

impl JsonEncodable for ResponseHeader

fn encode( &self, stream: &mut JsonStreamWriter<&mut dyn Write>, ctx: &Context<'_>, ) -> EncodingResult<()>

Write the type to the provided JSON writer.

impl PartialEq for ResponseHeader

fn eq(&self, other: &ResponseHeader) -> 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 UaNullable for ResponseHeader

fn is_ua_null(&self) -> bool

Return true if this value is null, meaning it can be left out when being encoded in JSON and XML encodings.

impl XmlDecodable for ResponseHeader

fn decode( stream: &mut XmlStreamReader<&mut dyn Read>, ctx: &Context<'_>, ) -> EncodingResult<Self>

Decode a value from an XML stream.

impl XmlEncodable for ResponseHeader

fn encode( &self, stream: &mut XmlStreamWriter<&mut dyn Write>, ctx: &Context<'_>, ) -> EncodingResult<()>

Encode a value to an XML stream.

impl XmlType for ResponseHeader

const TAG: &'static str = "ResponseHeader"

The static fallback tag for this type. Convenience feature, but also used in nested types.

fn tag(&self) -> &str

The XML tag name for this type.

impl StructuralPartialEq for ResponseHeader