Struct ijson::array::IArray

#[repr(transparent)]pub struct IArray(_);

The IArray type is similar to a Vec<IValue>. The primary difference is that the length and capacity are stored inside the heap allocation, so that the IArray itself can be a single pointer.

Implementations

impl IArray

pub fn new() -> Self

Constructs a new empty IArray. Does not allocate.

pub fn with_capacity(cap: usize) -> Self

Constructs a new IArray with the specified capacity. At least that many items can be added to the array without reallocating.

pub fn capacity(&self) -> usize

Returns the capacity of the array. This is the maximum number of items the array can hold without reallocating.

pub fn len(&self) -> usize

Returns the number of items currently stored in the array.

pub fn is_empty(&self) -> bool

Returns true if the array is empty.

pub fn as_slice(&self) -> &[IValue]

Borrows a slice of IValues from the array

pub fn as_mut_slice(&mut self) -> &mut [IValue]

Borrows a mutable slice of IValues from the array

pub fn reserve(&mut self, additional: usize)

Reserves space for at least this many additional items.

pub fn truncate(&mut self, len: usize)

Truncates the array by removing items until it is no longer than the specified length. The capacity is unchanged.

pub fn clear(&mut self)

Removes all items from the array. The capacity is unchanged.

pub fn insert(&mut self, index: usize, item: impl Into<IValue>)

Inserts a new item into the array at the specified index. Any existing items on or after this index will be shifted down to accomodate this. For large arrays, insertions near the front will be slow as it will require shifting a large number of items.

pub fn remove(&mut self, index: usize) -> Option<IValue>

Removes and returns the item at the specified index from the array. Any items after this index will be shifted back up to close the gap. For large arrays, removals from near the front will be slow as it will require shifting a large number of items.

If the order of the array is unimporant, consider using IArray::swap_remove.

If the index is outside the array bounds, None is returned.

pub fn swap_remove(&mut self, index: usize) -> Option<IValue>

Removes and returns the item at the specified index from the array by first swapping it with the item currently at the end of the array, and then popping that last item.

This can be more efficient than IArray::remove for large arrays, but will change the ordering of items within the array.

If the index is outside the array bounds, None is returned.

pub fn push(&mut self, item: impl Into<IValue>)

Pushes a new item onto the back of the array.

pub fn pop(&mut self) -> Option<IValue>

Pops the last item from the array and returns it. If the array is empty, None is returned.

pub fn shrink_to_fit(&mut self)

Shrinks the memory allocation used by the array such that its capacity becomes equal to its length.

Trait Implementations

impl AsMut<IValue> for IArray

pub fn as_mut(&mut self) -> &mut IValue

Performs the conversion.

impl AsRef<[IValue]> for IArray

pub fn as_ref(&self) -> &[IValue]

Performs the conversion.

impl AsRef<IValue> for IArray

pub fn as_ref(&self) -> &IValue

Performs the conversion.

impl Borrow<[IValue]> for IArray

pub fn borrow(&self) -> &[IValue]

Immutably borrows from an owned value.

impl Borrow<IValue> for IArray

pub fn borrow(&self) -> &IValue

Immutably borrows from an owned value.

impl BorrowMut<[IValue]> for IArray

pub fn borrow_mut(&mut self) -> &mut [IValue]

Mutably borrows from an owned value.

impl BorrowMut<IValue> for IArray

pub fn borrow_mut(&mut self) -> &mut IValue

Mutably borrows from an owned value.

impl Clone for IArray

pub fn clone(&self) -> IArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IArray

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

Formats the value using the given formatter.

impl Default for IArray

pub fn default() -> Self

Returns the "default value" for a type.

impl Deref for IArray

type Target = [IValue]

The resulting type after dereferencing.

pub fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for IArray

pub fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for IArray

pub fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'de> Deserializer<'de> for &'de IArray

type Error = Error

The error type that can be returned if some error occurs during deserialization.

pub fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, Error> where
    V: Visitor<'de>, 

Require the Deserializer to figure out how to drive the visitor based on what data type is in the input.

pub fn deserialize_newtype_struct<V>(
    self,
    _name: &'static str,
    visitor: V
) -> Result<V::Value, Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a newtype struct with a particular name.

pub fn deserialize_bool<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a bool value.

pub fn deserialize_i8<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i8 value.

pub fn deserialize_i16<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i16 value.

pub fn deserialize_i32<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i32 value.

pub fn deserialize_i64<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i64 value.

pub fn deserialize_i128<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i128 value.

pub fn deserialize_u8<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u8 value.

pub fn deserialize_u16<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u16 value.

pub fn deserialize_u32<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u32 value.

pub fn deserialize_u64<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u64 value.

pub fn deserialize_u128<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an u128 value.

pub fn deserialize_f32<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a f32 value.

pub fn deserialize_f64<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a f64 value.

pub fn deserialize_char<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a char value.

pub fn deserialize_str<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a string value and does not benefit from taking ownership of buffered data owned by the Deserializer.

pub fn deserialize_string<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a string value and would benefit from taking ownership of buffered data owned by the Deserializer.

pub fn deserialize_bytes<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a byte array and does not benefit from taking ownership of buffered data owned by the Deserializer.

pub fn deserialize_byte_buf<V>(
    self,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a byte array and would benefit from taking ownership of buffered data owned by the Deserializer.

pub fn deserialize_option<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an optional value.

pub fn deserialize_unit<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a unit value.

pub fn deserialize_unit_struct<V>(
    self,
    name: &'static str,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a unit struct with a particular name.

pub fn deserialize_seq<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a sequence of values.

pub fn deserialize_tuple<V>(
    self,
    len: usize,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a sequence of values and knows how many values there are without looking at the serialized data.

pub fn deserialize_tuple_struct<V>(
    self,
    name: &'static str,
    len: usize,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a tuple struct with a particular name and number of fields.

pub fn deserialize_map<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a map of key-value pairs.

pub fn deserialize_struct<V>(
    self,
    name: &'static str,
    fields: &'static [&'static str],
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a struct with a particular name and fields.

pub fn deserialize_enum<V>(
    self,
    name: &'static str,
    variants: &'static [&'static str],
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an enum value with a particular name and possible variants.

pub fn deserialize_identifier<V>(
    self,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting the name of a struct field or the discriminant of an enum variant.

pub fn deserialize_ignored_any<V>(
    self,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type needs to deserialize a value whose type doesn't matter because it is ignored.

pub fn is_human_readable(&self) -> bool

Determine whether Deserialize implementations should expect to deserialize their human-readable form.

impl Eq for IArray

impl<U: Into<IValue>> Extend<U> for IArray

pub fn extend<T: IntoIterator<Item = U>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<T: Into<IValue> + Clone, '_> From<&'_ [T]> for IArray

pub fn from(other: &[T]) -> Self

Performs the conversion.

impl From<IArray> for IValue

pub fn from(other: IArray) -> Self

Performs the conversion.

impl<T: Into<IValue>> From<Vec<T>> for IArray

pub fn from(other: Vec<T>) -> Self

Performs the conversion.

impl<U: Into<IValue>> FromIterator<U> for IArray

pub fn from_iter<T: IntoIterator<Item = U>>(iter: T) -> Self

Creates a value from an iterator.

impl Hash for IArray

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<I: SliceIndex<[IValue]>> Index<I> for IArray

type Output = I::Output

The returned type after indexing.

pub fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<I: SliceIndex<[IValue]>> IndexMut<I> for IArray

pub fn index_mut(&mut self, index: I) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IntoIterator for IArray

type Item = IValue

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a IArray

type Item = &'a IValue

The type of the elements being iterated over.

type IntoIter = Iter<'a, IValue>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut IArray

type Item = &'a mut IValue

The type of the elements being iterated over.

type IntoIter = IterMut<'a, IValue>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<IArray> for IArray

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<IArray> for IArray

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 Serialize for IArray

pub fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a IValue> for &'a IArray

type Error = ()

The type returned in the event of a conversion error.

pub fn try_from(other: &'a IValue) -> Result<Self, ()>

Performs the conversion.

impl<'a> TryFrom<&'a mut IValue> for &'a mut IArray

type Error = ()

The type returned in the event of a conversion error.

pub fn try_from(other: &'a mut IValue) -> Result<Self, ()>

Performs the conversion.

impl TryFrom<IValue> for IArray

type Error = IValue

The type returned in the event of a conversion error.

pub fn try_from(other: IValue) -> Result<Self, IValue>

Performs the conversion.