Enum foundation_ur::UR

pub enum UR<'a> {
    SinglePart {
        ur_type: &'a str,
        message: &'a str,
    },
    SinglePartDeserialized {
        ur_type: &'a str,
        message: &'a [u8],
    },
    MultiPart {
        ur_type: &'a str,
        fragment: &'a str,
        sequence: u32,
        sequence_count: u32,
    },
    MultiPartDeserialized {
        ur_type: &'a str,
        fragment: Part<'a>,
    },
}

An uniform resource.

Variants

SinglePart

A single-part resource.

Fields

ur_type: &'a str

The type.

message: &'a str

The message.

SinglePartDeserialized

A deserialized single-part resource.

Fields

ur_type: &'a str

The type.

message: &'a [u8]

The message.

MultiPart

A multiple-part resource.

Fields

ur_type: &'a str

The type.

fragment: &'a str

The fragment.

sequence: u32

The sequence number.

sequence_count: u32

The total sequence count.

MultiPartDeserialized

A deserialized multiple-part resource.

Fields

ur_type: &'a str

The type.

fragment: Part<'a>

The fragment.

Implementations

impl<'a> UR<'a>

pub fn new(ur_type: &'a str, message: &'a [u8]) -> Self

Construct a new single-part UR.

pub fn parse(s: &'a str) -> Result<Self, ParseURError>

Parses an uniform resource string.

Keep in mind, this does not deserialize the bytewords payload, deserialization is performed separately, for example, by the decoder.

pub fn is_single_part(&self) -> bool

Returns true if the Uniform Resource is single-part.

pub fn is_multi_part(&self) -> bool

Returns true if the Uniform Resource is multi-part.

pub fn is_deserialized(&self) -> bool

Returns true if this Uniform Resource is multi-part and deserialized.

pub fn as_type(&self) -> &str

Returns the UR type.

pub fn as_bytewords(&self) -> Option<&str>

Returns Some(bytewords) if the Uniform Resource is serialized.

pub fn as_part(&self) -> Option<&Part<'_>>

Returns Some(part) if the Uniform Resource is multi-part and is deserialized.

pub fn sequence(&self) -> Option<u32>

Returns Some(n) where n is the sequence number if the Uniform Resource is multi part.

pub fn sequence_count(&self) -> Option<u32>

Returns Some(n) where n is the sequence count if the Uniform Resource is multi part.

Trait Implementations

impl<'a> Clone for UR<'a>

fn clone(&self) -> UR<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for UR<'a>

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

Formats the value using the given formatter.

impl<'a> Display for UR<'a>

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

Formats the value using the given formatter.