Struct ascii::AsciiString [] [src]

pub struct AsciiString { /* fields omitted */ }

A growable string stored as an ASCII encoded buffer.

Methods

impl AsciiString
[src]

Creates a new, empty ASCII string buffer without allocating.

Examples

let mut s = AsciiString::new();Run

Creates a new ASCII string buffer with the given capacity. The string will be able to hold exactly capacity bytes without reallocating. If capacity is 0, the ASCII string will not allocate.

Examples

let mut s = AsciiString::with_capacity(10);Run

Creates a new AsciiString from a length, capacity and pointer.

Safety

This is highly unsafe, due to the number of invariants that aren't checked:

  • The memory at ptr need to have been previously allocated by the same allocator this library uses.
  • length needs to be less than or equal to capacity.
  • capacity needs to be the correct value.

Violating these may cause problems like corrupting the allocator's internal datastructures.

Examples

Basic usage:

use std::mem;

unsafe {
   let s = AsciiString::from_ascii("hello").unwrap();
   let ptr = s.as_ptr();
   let len = s.len();
   let capacity = s.capacity();

   mem::forget(s);

   let s = AsciiString::from_raw_parts(ptr as *mut _, len, capacity);

   assert_eq!(AsciiString::from_ascii("hello").unwrap(), s);
}Run

Converts a vector of bytes to an AsciiString without checking for non-ASCII characters.

Safety

This function is unsafe because it does not check that the bytes passed to it are valid ASCII characters. If this constraint is violated, it may cause memory unsafety issues with future of the AsciiString, as the rest of this library assumes that AsciiStrings are ASCII encoded.

Converts anything that can represent a byte buffer into an AsciiString.

Failure

Returns the byte buffer if not all of the bytes are ASCII characters.

Examples

let foo = AsciiString::from_ascii("foo").unwrap();
let err = AsciiString::from_ascii("Ŋ");
assert_eq!(foo.as_str(), "foo");
assert_eq!(err, Err("Ŋ"));Run

Pushes the given ASCII string onto this ASCII string buffer.

Examples

use std::str::FromStr;
let mut s = AsciiString::from_str("foo").unwrap();
s.push_str("bar".as_ascii_str().unwrap());
assert_eq!(s, "foobar".as_ascii_str().unwrap());Run

Returns the number of bytes that this ASCII string buffer can hold without reallocating.

Examples

let s = String::with_capacity(10);
assert!(s.capacity() >= 10);Run

Reserves capacity for at least additional more bytes to be inserted in the given AsciiString. The collection may reserve more space to avoid frequent reallocations.

Panics

Panics if the new capacity overflows usize.

Examples

let mut s = AsciiString::new();
s.reserve(10);
assert!(s.capacity() >= 10);Run

Reserves the minimum capacity for exactly additional more bytes to be inserted in the given AsciiString. Does nothing if the capacity is already sufficient.

Note that the allocator may give the collection more space than it requests. Therefore capacity can not be relied upon to be precisely minimal. Prefer reserve if future insertions are expected.

Panics

Panics if the new capacity overflows usize.

Examples

let mut s = AsciiString::new();
s.reserve_exact(10);
assert!(s.capacity() >= 10);Run

Shrinks the capacity of this ASCII string buffer to match it's length.

Examples

use std::str::FromStr;
let mut s = AsciiString::from_str("foo").unwrap();
s.reserve(100);
assert!(s.capacity() >= 100);
s.shrink_to_fit();
assert_eq!(s.capacity(), 3);Run

Adds the given ASCII character to the end of the ASCII string.

Examples

let mut s = AsciiString::from_ascii("abc").unwrap();
s.push(AsciiChar::from('1').unwrap());
s.push(AsciiChar::from('2').unwrap());
s.push(AsciiChar::from('3').unwrap());
assert_eq!(s, "abc123");Run

Shortens a ASCII string to the specified length.

Panics

Panics if new_len > current length.

Examples

let mut s = AsciiString::from_ascii("hello").unwrap();
s.truncate(2);
assert_eq!(s, "he");Run

Removes the last character from the ASCII string buffer and returns it. Returns None if this string buffer is empty.

Examples

let mut s = AsciiString::from_ascii("foo").unwrap();
assert_eq!(s.pop().map(|c| c.as_char()), Some('o'));
assert_eq!(s.pop().map(|c| c.as_char()), Some('o'));
assert_eq!(s.pop().map(|c| c.as_char()), Some('f'));
assert_eq!(s.pop(), None);Run

Removes the ASCII character at position idx from the buffer and returns it.

Warning

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

Panics

If idx is out of bounds this function will panic.

Examples

let mut s = AsciiString::from_ascii("foo").unwrap();
assert_eq!(s.remove(0).as_char(), 'f');
assert_eq!(s.remove(1).as_char(), 'o');
assert_eq!(s.remove(0).as_char(), 'o');Run

Inserts an ASCII character into the buffer at position idx.

Warning

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

Panics

If idx is out of bounds this function will panic.

Examples

let mut s = AsciiString::from_ascii("foo").unwrap();
s.insert(2, AsciiChar::b);
assert_eq!(s, "fobo");Run

Returns the number of bytes in this ASCII string.

Examples

let s = AsciiString::from_ascii("foo").unwrap();
assert_eq!(s.len(), 3);Run

Returns true if the ASCII string contains zero bytes.

Examples

let mut s = AsciiString::new();
assert!(s.is_empty());
s.push(AsciiChar::from('a').unwrap());
assert!(!s.is_empty());Run

Truncates the ASCII string, setting length (but not capacity) to zero.

Examples

let mut s = AsciiString::from_ascii("foo").unwrap();
s.clear();
assert!(s.is_empty());Run

Methods from Deref<Target=AsciiStr>

Converts &self to a &str slice.

Converts &self into a byte slice.

Returns the entire string as slice of AsciiChars.

Returns the entire string as mutable slice of AsciiChars.

Returns a raw pointer to the AsciiStr's buffer.

The caller must ensure that the slice outlives the pointer this function returns, or else it will end up pointing to garbage. Modifying the AsciiStr may cause it's buffer to be reallocated, which would also make any pointers to it invalid.

Returns an unsafe mutable pointer to the AsciiStr's buffer.

The caller must ensure that the slice outlives the pointer this function returns, or else it will end up pointing to garbage. Modifying the AsciiStr may cause it's buffer to be reallocated, which would also make any pointers to it invalid.

Copies the content of this AsciiStr into an owned AsciiString.

Returns the number of characters / bytes in this ASCII sequence.

Examples

let s = AsciiStr::from_ascii("foo").unwrap();
assert_eq!(s.len(), 3);Run

Returns true if the ASCII slice contains zero bytes.

Examples

let mut empty = AsciiStr::from_ascii("").unwrap();
let mut full = AsciiStr::from_ascii("foo").unwrap();
assert!(empty.is_empty());
assert!(!full.is_empty());Run

Returns an ASCII string slice with leading and trailing whitespace removed.

Examples

let example = AsciiStr::from_ascii("  \twhite \tspace  \t").unwrap();
assert_eq!("white \tspace", example.trim());Run

Returns an ASCII string slice with leading whitespace removed.

Examples

let example = AsciiStr::from_ascii("  \twhite \tspace  \t").unwrap();
assert_eq!("white \tspace  \t", example.trim_left());Run

Returns an ASCII string slice with trailing whitespace removed.

Examples

let example = AsciiStr::from_ascii("  \twhite \tspace  \t").unwrap();
assert_eq!("  \twhite \tspace", example.trim_right());Run

Trait Implementations

impl Clone for AsciiString
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl Default for AsciiString
[src]

Returns the "default value" for a type. Read more

impl PartialEq for AsciiString
[src]

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

This method tests for !=.

impl Eq for AsciiString
[src]

impl PartialOrd for AsciiString
[src]

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

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

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

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

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

impl Ord for AsciiString
[src]

This method returns an Ordering between self and other. Read more

impl Hash for AsciiString
[src]

Feeds this value into the state given, updating the hasher as necessary.

Feeds a slice of this type into the state provided.

impl Deref for AsciiString
[src]

The resulting type after dereferencing

The method called to dereference a value

impl DerefMut for AsciiString
[src]

The method called to mutably dereference a value

impl PartialEq<str> for AsciiString
[src]

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

This method tests for !=.

impl<'a> PartialEq<String> for AsciiString
[src]

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

This method tests for !=.

impl<'a> PartialEq<&'a AsciiStr> for AsciiString
[src]

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

This method tests for !=.

impl<'a> PartialEq<&'a str> for AsciiString
[src]

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

This method tests for !=.

impl Borrow<AsciiStr> for AsciiString
[src]

Immutably borrows from an owned value. Read more

impl From<Vec<AsciiChar>> for AsciiString
[src]

Performs the conversion.

impl Into<Vec<u8>> for AsciiString
[src]

Performs the conversion.

impl Into<String> for AsciiString
[src]

Performs the conversion.

impl AsRef<AsciiStr> for AsciiString
[src]

Performs the conversion.

impl AsMut<AsciiStr> for AsciiString
[src]

Performs the conversion.

impl FromStr for AsciiString
[src]

The associated error which can be returned from parsing.

Parses a string s to return a value of this type. Read more

impl Display for AsciiString
[src]

Formats the value using the given formatter.

impl Debug for AsciiString
[src]

Formats the value using the given formatter.

impl FromIterator<AsciiChar> for AsciiString
[src]

Creates a value from an iterator. Read more

impl<'a> FromIterator<&'a AsciiStr> for AsciiString
[src]

Creates a value from an iterator. Read more

impl Extend<AsciiChar> for AsciiString
[src]

Extends a collection with the contents of an iterator. Read more

impl<'a> Extend<&'a AsciiChar> for AsciiString
[src]

Extends a collection with the contents of an iterator. Read more

impl<'a> Extend<&'a AsciiStr> for AsciiString
[src]

Extends a collection with the contents of an iterator. Read more

impl<'a> Add<&'a AsciiStr> for AsciiString
[src]

The resulting type after applying the + operator

The method for the + operator

impl<T> Index<T> for AsciiString where AsciiStr: Index<T>
[src]

The returned type after indexing

The method for the indexing (Foo[Bar]) operation

impl<T> IndexMut<T> for AsciiString where AsciiStr: IndexMut<T>
[src]

The method for the indexing (Foo[Bar]) operation

impl IntoAsciiString for AsciiString
[src]

Convert to AsciiString without checking for non-ASCII characters.

Convert to AsciiString.