Struct LocalizedText 

pub struct LocalizedText {
    pub locale: UAString,
    pub text: UAString,
}

A human readable text with an optional locale identifier.

Fields

locale: UAString

The locale. Omitted from stream if null or empty

text: UAString

The text in the specified locale. Omitted from stream if null or empty.

Implementations

impl LocalizedText

pub fn new(locale: &str, text: &str) -> LocalizedText

Create a new LocalizedText from the specified locale and text.

pub fn null() -> LocalizedText

Create a null LocalizedText.

Trait Implementations

impl BinaryDecodable for LocalizedText

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 LocalizedText

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 LocalizedText

fn clone(&self) -> LocalizedText

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LocalizedText

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

Formats the value using the given formatter.

impl Default for LocalizedText

fn default() -> LocalizedText

Returns the “default value” for a type.

impl Display for LocalizedText

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

Formats the value using the given formatter.

impl From<&String> for LocalizedText

fn from(value: &String) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for LocalizedText

fn from(value: &'a str) -> Self

Converts to this type from the input type.

impl From<LocalizedText> for DataValue

fn from(v: LocalizedText) -> Self

Converts to this type from the input type.

impl From<String> for LocalizedText

fn from(value: String) -> Self

Converts to this type from the input type.

impl IntoVariant for Box<LocalizedText>

fn into_variant(self) -> Variant

Convert self into a variant.

impl IntoVariant for LocalizedText

fn into_variant(self) -> Variant

Convert self into a variant.

impl JsonDecodable for LocalizedText

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

Decode Self from a JSON stream.

impl JsonEncodable for LocalizedText

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

Write the type to the provided JSON writer.

impl PartialEq for LocalizedText

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

fn try_from_variant(v: Variant) -> Result<Self, Error>

Try to cast the given variant to this type.

impl UaNullable for LocalizedText

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 VariantType for LocalizedText

fn variant_type_id() -> VariantScalarTypeId

The variant kind this type will be represented as.

impl XmlDecodable for LocalizedText

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

Decode a value from an XML stream.

impl XmlEncodable for LocalizedText

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

Encode a value to an XML stream.

impl XmlType for LocalizedText

const TAG: &'static str = "LocalizedText"

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 LocalizedText