Struct sval::Index

pub struct Index(/* private fields */);

Expand description

The index of a value in its parent context.

Implementations§

impl Index

pub const fn new(index: usize) -> Self

Create a new index from a numeric value.

pub const fn new_u32(index: u32) -> Self

Create a new None index from a 32bit numeric value.

pub const fn new_u64(index: u64) -> Self

Create a new None index from a 64bit numeric value.

pub const fn new_i32(index: i32) -> Self

Create a new None index from a signed 32bit numeric value.

pub const fn new_i64(index: i64) -> Self

Create a new None index from a signed 64bit numeric value.

pub const fn new_isize(index: isize) -> Self

Create a new None index from a signed numeric value.

pub const fn to_usize(&self) -> Option<usize>

Try get the index as a numeric value.

pub const fn to_u32(&self) -> Option<u32>

Try get the index as a 32-bit numeric value.

pub const fn to_u64(&self) -> Option<u64>

Try get the index as a 64-bit numeric value.

pub const fn to_isize(&self) -> Option<isize>

Try get the index as a signed numeric value.

pub const fn to_i32(&self) -> Option<i32>

Try get the index as a signed 32-bit numeric value.

pub const fn to_i64(&self) -> Option<i64>

Try get the index as a signed 64-bit numeric value.

pub const fn with_tag(self, tag: &Tag) -> Self

Associate a tag as a hint with this index.

Tags don’t contribute to equality or ordering of indexes but streams may use the them when interpreting the index value.

pub const fn tag(&self) -> Option<&Tag>

Get the tag hint associated with the index, if present.

Streams may use the tag when interpreting the index value.

Trait Implementations§

impl Clone for Index

fn clone(&self) -> Index

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for Index

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

Formats the value using the given formatter. Read more

impl Display for Index

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

Formats the value using the given formatter. Read more

impl From<i32> for Index

fn from(index: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Index

fn from(index: i64) -> Self

Converts to this type from the input type.

impl From<isize> for Index

fn from(index: isize) -> Self

Converts to this type from the input type.

impl From<u32> for Index

fn from(index: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Index

fn from(index: u64) -> Self

Converts to this type from the input type.

impl From<usize> for Index

fn from(index: usize) -> Self

Converts to this type from the input type.

impl Hash for Index

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

impl Ord for Index

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more

1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more

1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more

impl PartialEq for Index

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

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 PartialOrd for Index

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl Eq for Index

Auto Trait Implementations§

impl Freeze for Index

impl RefUnwindSafe for Index

impl Send for Index

impl Sync for Index

impl Unpin for Index

impl UnwindSafe for Index

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T> ToString for T
where T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.