Skip to main content

KxSnRef

Struct KxSnRef 

Source
pub struct KxSnRef<'a> { /* private fields */ }
Expand description

Zero-copy view over the k elements of a KxSn array (each element is a 2-byte, byte-order-dependent length prefix followed by the payload).

Elements are decoded with the same rule as SnRef::as_str and can be iterated directly:

use rust_stdf::{ByteOrder, KxSnRef};

let raw = [2, 0, b'A', b'B', 2, 0, b'C', b'D']; // two elements: "AB", "CD"
let kx = KxSnRef::new(&raw, 0, 2, ByteOrder::LittleEndian);
for s in &kx {
    println!("{s}");
}

Implementations§

Source§

impl<'a> KxSnRef<'a>

Source

pub fn new(raw: &'a [u8], start: usize, k: usize, order: ByteOrder) -> Self

Construct a view over k elements starting at byte offset start, using order for the 2-byte length prefixes.

Normally obtained from a generated *View getter; only needed when parsing a known raw layout directly.

Source

pub fn len(&self) -> usize

Number of string elements in the array.

Source

pub fn is_empty(&self) -> bool

true when the array has no elements.

Source

pub fn get_str(&self, i: usize) -> Option<Cow<'a, str>>

Decoded i-th element; None when i is out of range.

Valid UTF-8 payloads are borrowed zero-copy; other payloads are decoded byte → char (Latin-1) into an owned String.

Source

pub fn get_bytes(&self, i: usize) -> Option<&'a [u8]>

Raw payload bytes of the i-th element (without the length prefix); None when i is out of range.

Source

pub fn iter(&self) -> KxSnRefIter<'a> ⓘ

Iterator over the decoded elements, one pass.

Source

pub fn as_vec(&self) -> Vec<Cow<'a, str>>

Allocating; collects all elements into Vec<Cow<'a, str>>.

Source

pub fn to_owned(&self) -> KxSn

Allocating; reproduces the owned KxSn (Vec<String>), matching the eager parser.

Trait Implementations§

Source§

impl<'a> Clone for KxSnRef<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for KxSnRef<'a>

Source§

impl<'a> Default for KxSnRef<'a>

Source§

fn default() -> Self

Return KxSnRef { raw: Default::default(), start: Default::default(), k: Default::default(), order: ByteOrder :: LittleEndian }

Source§

impl<'a> IntoIterator for &'a KxSnRef<'a>

Source§

type Item = Cow<'a, str>

The type of the elements being iterated over.
Source§

type IntoIter = KxSnRefIter<'a>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for KxSnRef<'a>

§

impl<'a> RefUnwindSafe for KxSnRef<'a>

§

impl<'a> Send for KxSnRef<'a>

§

impl<'a> Sync for KxSnRef<'a>

§

impl<'a> Unpin for KxSnRef<'a>

§

impl<'a> UnsafeUnpin for KxSnRef<'a>

§

impl<'a> UnwindSafe for KxSnRef<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.