Struct tinyvec_string::arraystring::CapacityOverflowError

pub struct CapacityOverflowError<S> { /* fields omitted */ }

An error was caused converting another string type into an ArrayString.

This type contains the amount by which the capacity was overflown, and the input string (when possible).

Examples

use std::convert::TryFrom;
let result = ArrayString::<[u8; 3]>::try_from("foobar");

assert!(result.is_err());
let err: CapacityOverflowError<&str> = result.unwrap_err();

assert_eq!(err.overflow_amount(), 3);
assert_eq!(err.into_inner(), "foobar");

Implementations

impl<S> CapacityOverflowError<S>

pub fn overflow_amount(&self) -> usize

Get the amount by which the capacity was overflown, i.e. the amount of extra capacity that would've been needed to store the string.

pub fn into_inner(self) -> S

Retrieve the input string.

Examples

This could be used to retrieve a String that failed to convert:

use std::convert::TryFrom;
let heap_string = String::from("a very long string");
let result = ArrayString::<[u8; 5]>::try_from(heap_string);

assert!(result.is_err());
let err: CapacityOverflowError<String> = result.unwrap_err();
let return_of_the_heap_string = err.into_inner();

assert_eq!(return_of_the_heap_string, String::from("a very long string"));

Trait Implementations

impl<S: Clone> Clone for CapacityOverflowError<S>

fn clone(&self) -> CapacityOverflowError<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Copy> Copy for CapacityOverflowError<S>

impl<S: Debug> Debug for CapacityOverflowError<S>

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

Formats the value using the given formatter.

impl<S: Display> Display for CapacityOverflowError<S>

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

Formats the value using the given formatter.

impl<S: Eq> Eq for CapacityOverflowError<S>

impl<S: Ord> Ord for CapacityOverflowError<S>

fn cmp(&self, other: &CapacityOverflowError<S>) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<S: PartialEq> PartialEq<CapacityOverflowError<S>> for CapacityOverflowError<S>

fn eq(&self, other: &CapacityOverflowError<S>) -> bool

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

fn ne(&self, other: &CapacityOverflowError<S>) -> bool

This method tests for !=.

impl<S: PartialOrd> PartialOrd<CapacityOverflowError<S>> for CapacityOverflowError<S>

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

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

fn lt(&self, other: &CapacityOverflowError<S>) -> bool

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

fn le(&self, other: &CapacityOverflowError<S>) -> bool

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

fn gt(&self, other: &CapacityOverflowError<S>) -> bool

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

fn ge(&self, other: &CapacityOverflowError<S>) -> bool

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

impl<S> StructuralEq for CapacityOverflowError<S>

impl<S> StructuralPartialEq for CapacityOverflowError<S>