Struct StringView 

pub struct StringView<'a> { /* private fields */ }

A borrowed ProtoCache byte string.

ProtoCache does not require string payloads to be UTF-8; use Self::as_str when text validation is required.

Implementations

impl<'a> StringView<'a>

pub fn new(words: &'a [u32]) -> Option<Self>

Parses a string/bytes object from the beginning of words.

pub fn detect_len(words: &'a [u32]) -> Option<usize>

Returns the encoded object length in words without constructing a view.

pub fn detect(words: &'a [u32]) -> Option<&'a [u32]>

Returns the exact encoded subslice occupied by the string/bytes object.

pub fn as_bytes(self) -> &'a [u8]

Returns the payload without UTF-8 validation.

pub fn as_str(self) -> Option<&'a str>

Returns the payload as text, or None if it is not valid UTF-8.

Examples found in repository

examples/basic.rs (line 13)

fn main() {
    let mut buffer = Buffer::new();
    let name = serialize_str("Ada", &mut buffer).expect("name is encodable");
    let mut fields = [serialize_scalar(42_i32), name];
    serialize_message(&mut fields, &mut buffer).expect("message is encodable");

    let view = MessageView::new(buffer.view()).expect("valid ProtoCache message");
    let id = view.scalar::<i32>(0).expect("id field");
    let name = view
        .string(1)
        .and_then(|value| value.as_str())
        .expect("UTF-8 name field");

    println!("id={id}, name={name}");
}

pub fn as_bool_array(self) -> BoolArray<'a>

Interprets every payload byte as one boolean value.

Trait Implementations

impl AsRef<[u8]> for StringView<'_>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Clone for StringView<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for StringView<'a>

impl<'a> Debug for StringView<'a>

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

Formats the value using the given formatter.

impl<'a> Display for StringView<'a>

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

Formats the value using the given formatter.

impl<'a> FieldDecode<'a> for StringView<'a>

fn decode(field: FieldView<'a>) -> Option<Self>

Returns None when the field does not have the expected shape.