Skip to main content

DynamicArray

Struct DynamicArray 

Source
pub struct DynamicArray<Length, Collection> { /* private fields */ }
Expand description

Dynamically sized array.

Used to serialize and deserialize arbitrary collections using specific length fields.

Works on any type that implements IntoIterator<Item = Serialize> which includes Vec<T>, BTreeMap<K, V>, and Option<T>.

The length can be LengthZero, LengthU8, LengthU16 or LengthU32 for 0, 8, 16, and 32 bit length fields, respectively.

§Examples

use rsomeip_bytes::{Deserialize as _, DynamicArray, LengthU32, Serialize as _};

// Works on any value that implements `IntoIterator`.
let value = vec![1, 2, 3, 4, 5];

// Specify the size of the length field in the generic parameters. It will be included when
// serializing the value.
let array = DynamicArray::<LengthU32, _>::from(&value);

// The array also implements the `Serialize` trait.
let mut bytes = array.to_bytes()?;

// And `Deserialize`, as well.
let output = DynamicArray::<LengthU32, Vec<i32>>::deserialize(&mut bytes)?;
assert_eq!(value, output);

Trait Implementations§

Source§

impl<Length: Clone, Collection: Clone> Clone for DynamicArray<Length, Collection>

Source§

fn clone(&self) -> DynamicArray<Length, Collection>

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<Length: Copy, Collection: Copy> Copy for DynamicArray<Length, Collection>

Source§

impl<Length: Debug, Collection: Debug> Debug for DynamicArray<Length, Collection>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<Length, Collection> Deserialize for DynamicArray<Length, Collection>
where Length: Length, Collection: IntoIterator + FromIterator<<Collection::Item as Deserialize>::Output>, Collection::Item: Deserialize,

Source§

type Output = Collection

Type of the deserialized data.
Source§

fn deserialize<Buffer>( buffer: &mut Buffer, ) -> Result<Self::Output, DeserializeError>
where Buffer: Buf + ?Sized,

Deserializes an instance of Deserialize::Output from the buffer. Read more
Source§

fn size_hint() -> Option<usize>

Returns the minimum size of a correctly serialized Self::Output. Read more
Source§

impl<Length: Eq, Collection: Eq> Eq for DynamicArray<Length, Collection>

Source§

impl<Length, Collection> From<Collection> for DynamicArray<Length, Collection>
where Length: Length, Collection: IntoIterator + Copy, Collection::Item: Serialize,

Source§

fn from(collection: Collection) -> Self

Converts to this type from the input type.
Source§

impl<Length: Hash, Collection: Hash> Hash for DynamicArray<Length, Collection>

Source§

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
Source§

impl<Length: Ord, Collection: Ord> Ord for DynamicArray<Length, Collection>

Source§

fn cmp(&self, other: &DynamicArray<Length, Collection>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl<Length: PartialEq, Collection: PartialEq> PartialEq for DynamicArray<Length, Collection>

Source§

fn eq(&self, other: &DynamicArray<Length, Collection>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<Length: PartialOrd, Collection: PartialOrd> PartialOrd for DynamicArray<Length, Collection>

Source§

fn partial_cmp( &self, other: &DynamicArray<Length, Collection>, ) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · 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 (const: unstable) · 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 (const: unstable) · 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 (const: unstable) · 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
Source§

impl<Length, Collection> Serialize for DynamicArray<Length, Collection>
where Length: Length, Collection: IntoIterator + Copy, Collection::Item: Serialize,

Source§

fn serialize<Buffer>( &self, buffer: &mut Buffer, ) -> Result<usize, SerializeError>
where Buffer: BufMut + ?Sized,

Serializes self into the given buffer. Read more
Source§

fn size(&self) -> Option<usize>

Returns the size of self when serialized. Read more
Source§

fn to_bytes(&self) -> Result<Bytes, SerializeError>

Returns self serialized into Bytes. Read more
Source§

impl<Length: PartialEq, Collection: PartialEq> StructuralPartialEq for DynamicArray<Length, Collection>

Auto Trait Implementations§

§

impl<Length, Collection> Freeze for DynamicArray<Length, Collection>
where Collection: Freeze,

§

impl<Length, Collection> RefUnwindSafe for DynamicArray<Length, Collection>
where Collection: RefUnwindSafe, Length: RefUnwindSafe,

§

impl<Length, Collection> Send for DynamicArray<Length, Collection>
where Collection: Send, Length: Send,

§

impl<Length, Collection> Sync for DynamicArray<Length, Collection>
where Collection: Sync, Length: Sync,

§

impl<Length, Collection> Unpin for DynamicArray<Length, Collection>
where Collection: Unpin, Length: Unpin,

§

impl<Length, Collection> UnsafeUnpin for DynamicArray<Length, Collection>
where Collection: UnsafeUnpin,

§

impl<Length, Collection> UnwindSafe for DynamicArray<Length, Collection>
where Collection: UnwindSafe, Length: UnwindSafe,

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 = Infallible

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

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

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.