Struct sval::Index

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

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.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl Display for Index

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

Formats the value using the given formatter.

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.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Index

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Index

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Index