[][src]Struct arrayvec::ArrayString

pub struct ArrayString<A> where
    A: Array<Item = u8> + Copy
{ /* fields omitted */ }

A string with a fixed capacity.

The ArrayString is a string backed by a fixed size array. It keeps track of its length.

The string is a contiguous value that you can store directly on the stack if needed.

Implementations

impl<A> ArrayString<A> where
    A: Array<Item = u8> + Copy
[src]

pub fn new() -> ArrayString<A>[src]

Create a new empty ArrayString.

Capacity is inferred from the type parameter.

use arrayvec::ArrayString;

let mut string = ArrayString::<[_; 16]>::new();
string.push_str("foo");
assert_eq!(&string[..], "foo");
assert_eq!(string.capacity(), 16);

pub fn len(&self) -> usize[src]

Return the length of the string.

pub fn is_empty(&self) -> bool[src]

Returns whether the string is empty.

pub fn from(s: &str) -> Result<Self, CapacityError<&str>>[src]

Create a new ArrayString from a str.

Capacity is inferred from the type parameter.

Errors if the backing array is not large enough to fit the string.

use arrayvec::ArrayString;

let mut string = ArrayString::<[_; 3]>::from("foo").unwrap();
assert_eq!(&string[..], "foo");
assert_eq!(string.len(), 3);
assert_eq!(string.capacity(), 3);

pub fn from_byte_string(b: &A) -> Result<Self, Utf8Error>[src]

Create a new ArrayString from a byte string literal.

Errors if the byte string literal is not valid UTF-8.

use arrayvec::ArrayString;

let string = ArrayString::from_byte_string(b"hello world").unwrap();

pub fn capacity(&self) -> usize[src]

Return the capacity of the ArrayString.

use arrayvec::ArrayString;

let string = ArrayString::<[_; 3]>::new();
assert_eq!(string.capacity(), 3);

pub fn is_full(&self) -> bool[src]

Return if the ArrayString is completely filled.

use arrayvec::ArrayString;

let mut string = ArrayString::<[_; 1]>::new();
assert!(!string.is_full());
string.push_str("A");
assert!(string.is_full());

pub fn push(&mut self, c: char)[src]

Adds the given char to the end of the string.

Panics if the backing array is not large enough to fit the additional char.

use arrayvec::ArrayString;

let mut string = ArrayString::<[_; 2]>::new();

string.push('a');
string.push('b');

assert_eq!(&string[..], "ab");

pub fn try_push(&mut self, c: char) -> Result<(), CapacityError<char>>[src]

Adds the given char to the end of the string.

Returns Ok if the push succeeds.

Errors if the backing array is not large enough to fit the additional char.

use arrayvec::ArrayString;

let mut string = ArrayString::<[_; 2]>::new();

string.try_push('a').unwrap();
string.try_push('b').unwrap();
let overflow = string.try_push('c');

assert_eq!(&string[..], "ab");
assert_eq!(overflow.unwrap_err().element(), 'c');

pub fn push_str(&mut self, s: &str)[src]

Adds the given string slice to the end of the string.

Panics if the backing array is not large enough to fit the string.

use arrayvec::ArrayString;

let mut string = ArrayString::<[_; 2]>::new();

string.push_str("a");
string.push_str("d");

assert_eq!(&string[..], "ad");

pub fn try_push_str<'a>(
    &mut self,
    s: &'a str
) -> Result<(), CapacityError<&'a str>>
[src]

Adds the given string slice to the end of the string.

Returns Ok if the push succeeds.

Errors if the backing array is not large enough to fit the string.

use arrayvec::ArrayString;

let mut string = ArrayString::<[_; 2]>::new();

string.try_push_str("a").unwrap();
let overflow1 = string.try_push_str("bc");
string.try_push_str("d").unwrap();
let overflow2 = string.try_push_str("ef");

assert_eq!(&string[..], "ad");
assert_eq!(overflow1.unwrap_err().element(), "bc");
assert_eq!(overflow2.unwrap_err().element(), "ef");

pub fn pop(&mut self) -> Option<char>[src]

Removes the last character from the string and returns it.

Returns None if this ArrayString is empty.

use arrayvec::ArrayString;
 
let mut s = ArrayString::<[_; 3]>::from("foo").unwrap();

assert_eq!(s.pop(), Some('o'));
assert_eq!(s.pop(), Some('o'));
assert_eq!(s.pop(), Some('f'));

assert_eq!(s.pop(), None);

pub fn truncate(&mut self, new_len: usize)[src]

Shortens this ArrayString to the specified length.

If new_len is greater than the string’s current length, this has no effect.

Panics if new_len does not lie on a char boundary.

use arrayvec::ArrayString;

let mut string = ArrayString::<[_; 6]>::from("foobar").unwrap();
string.truncate(3);
assert_eq!(&string[..], "foo");
string.truncate(4);
assert_eq!(&string[..], "foo");

pub fn remove(&mut self, idx: usize) -> char[src]

Removes a char from this ArrayString at a byte position and returns it.

This is an O(n) operation, as it requires copying every element in the array.

Panics if idx is larger than or equal to the ArrayString’s length, or if it does not lie on a char boundary.

use arrayvec::ArrayString;
 
let mut s = ArrayString::<[_; 3]>::from("foo").unwrap();

assert_eq!(s.remove(0), 'f');
assert_eq!(s.remove(1), 'o');
assert_eq!(s.remove(0), 'o');

pub fn clear(&mut self)[src]

Make the string empty.

pub unsafe fn set_len(&mut self, length: usize)[src]

Set the strings’s length.

This function is unsafe because it changes the notion of the number of “valid” bytes in the string. Use with care.

This method uses debug assertions to check the validity of length and may use other debug assertions.

pub fn as_str(&self) -> &str[src]

Return a string slice of the whole ArrayString.

Trait Implementations

impl<A> AsRef<str> for ArrayString<A> where
    A: Array<Item = u8> + Copy
[src]

impl<A> Borrow<str> for ArrayString<A> where
    A: Array<Item = u8> + Copy
[src]

impl<A> Clone for ArrayString<A> where
    A: Array<Item = u8> + Copy
[src]

impl<A: Copy> Copy for ArrayString<A> where
    A: Array<Item = u8> + Copy,
    A::Index: Copy
[src]

impl<A> Debug for ArrayString<A> where
    A: Array<Item = u8> + Copy
[src]

impl<A> Default for ArrayString<A> where
    A: Array<Item = u8> + Copy
[src]

fn default() -> ArrayString<A>[src]

Return an empty ArrayString

impl<A> Deref for ArrayString<A> where
    A: Array<Item = u8> + Copy
[src]

type Target = str

The resulting type after dereferencing.

impl<A> DerefMut for ArrayString<A> where
    A: Array<Item = u8> + Copy
[src]

impl<'de, A> Deserialize<'de> for ArrayString<A> where
    A: Array<Item = u8> + Copy
[src]

Requires crate feature "serde"

impl<A> Display for ArrayString<A> where
    A: Array<Item = u8> + Copy
[src]

impl<A> Eq for ArrayString<A> where
    A: Array<Item = u8> + Copy
[src]

impl<A> FromStr for ArrayString<A> where
    A: Array<Item = u8> + Copy
[src]

type Err = CapacityError

The associated error which can be returned from parsing.

impl<A> Hash for ArrayString<A> where
    A: Array<Item = u8> + Copy
[src]

impl<A> Ord for ArrayString<A> where
    A: Array<Item = u8> + Copy
[src]

impl<A> PartialEq<ArrayString<A>> for ArrayString<A> where
    A: Array<Item = u8> + Copy
[src]

impl<A> PartialEq<ArrayString<A>> for str where
    A: Array<Item = u8> + Copy
[src]

impl<A> PartialEq<str> for ArrayString<A> where
    A: Array<Item = u8> + Copy
[src]

impl<A> PartialOrd<ArrayString<A>> for ArrayString<A> where
    A: Array<Item = u8> + Copy
[src]

impl<A> PartialOrd<ArrayString<A>> for str where
    A: Array<Item = u8> + Copy
[src]

impl<A> PartialOrd<str> for ArrayString<A> where
    A: Array<Item = u8> + Copy
[src]

impl<A> Serialize for ArrayString<A> where
    A: Array<Item = u8> + Copy
[src]

Requires crate feature "serde"

impl<A> Write for ArrayString<A> where
    A: Array<Item = u8> + Copy
[src]

Write appends written data to the end of the string.

Auto Trait Implementations

impl<A> RefUnwindSafe for ArrayString<A> where
    A: RefUnwindSafe,
    <A as Array>::Index: RefUnwindSafe

impl<A> Send for ArrayString<A> where
    A: Send,
    <A as Array>::Index: Send

impl<A> Sync for ArrayString<A> where
    A: Sync,
    <A as Array>::Index: Sync

impl<A> Unpin for ArrayString<A> where
    A: Unpin,
    <A as Array>::Index: Unpin

impl<A> UnwindSafe for ArrayString<A> where
    A: UnwindSafe,
    <A as Array>::Index: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> ToString for T where
    T: Display + ?Sized
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.