Struct std::string::StringBuf

A heap-allocated string.

It is a wrapper around a Vector of bytes. In addition to the methods provided by Vector, it provides protocol implementations for Formatter (allowing it to be a sink for write), Hashable, Equatable and Comparable.

Methods

• fn new() -> StringBuf

  source

  Create an empty string buffer.

  This will not allocate until the first byte is inserted.

• fn from_vector(vector: Vector<u8>) -> StringBuf

  source

  Create a string buffer from an existing vector.

• fn from_raw(data: &mut [u8], length: usize) -> StringBuf

  source

  Create a string buffer from a raw slice and a length.

  The slice must be allocated with alloc and its length must be greater than or equal to length.

• fn with_capacity(capacity: usize) -> StringBuf

  source

  Create a string buffer that can hold up to capacity bytes without reallocating.

• fn from_slice(slice: &[u8]) -> StringBuf

  source

  Create a string buffer from a slice, copying the bytes.

  Example

  use std::string::StringBuf;
  
  let str = StringBuf::from_slice("Hello, world!");
  assert_eq!(str.len(), 13);
  assert_eq!(str[..] as &[u8], "Hello, world!");
  Run this example

• fn from_iter<I>(iter: &mut I) -> StringBuf

  I: Iterator<I, u8>

  source

  Create a string buffer from an iterator of bytes.

  See also to_vector for a chainable version.

  Example

  use std::string::StringBuf;
  
  let str = StringBuf::from_iter(&('A'..='F'));
  assert_eq!(str.len(), 6);
  assert_eq!(str[..] as &[u8], "ABCDEF");
  Run this example

• fn reserve(self: &mut StringBuf, additional: usize)

  source

  Reserve capacity for at least additional bytes.

• fn extend_from_slice(self: &mut StringBuf, value: &[u8])

  source

  Extend the string buffer with the bytes from a slice.

  Example

  use std::string::StringBuf;
  
  let str = StringBuf::new();
  str.extend_from_slice("Hello, ");
  str.extend_from_slice("world!");
  assert_eq!(str.len(), 13);
  assert_eq!(str[..] as &[u8], "Hello, world!");
  Run this example

• fn extend<I>(self: &mut StringBuf, iter: &mut I)

  I: Iterator<I, u8>

  source

  Extend the string buffer with the bytes from an iterator.

• fn insert(self: &mut StringBuf, index: usize, value: u8)

  source

  Insert an byte at the given index, shifting all bytes after it.

  Example

  use std::string::StringBuf;
  
  let str = StringBuf::from_slice("luck");
  str.insert(0, 'p');
  assert_eq!(str.len(), 5);
  assert_eq!(str[..] as &[u8], "pluck");
  Run this example

• fn get(self: &StringBuf, index: usize) -> Option<u8>

  source

  Get the byte at the given index.

  If the index is out of bounds, it returns Option::none().

• fn as_slice(self: &StringBuf) -> &[u8]

  source

  Returns the contents of the object as a slice.

  See AsSlice for details.

• fn as_slice_mut(self: &mut StringBuf) -> &mut [u8]

  source

  Returns the contents of the object as a mutable slice.

  See AsSliceMut for details.

• fn push(self: &mut StringBuf, value: u8)

  source

  Push an byte to the end of the string buffer.

• fn pop(self: &mut StringBuf) -> Option<u8>

  source

  Pop an byte from the end of the string buffer.

  If the string buffer is empty, it returns Option::none().

• fn len(self: &StringBuf) -> usize

  source

  Return the length of the string buffer.

• fn capacity(self: &StringBuf) -> usize

  source

  Return the size of the underlying buffer.

• fn spare_capacity(self: &mut StringBuf) -> &mut [u8]

  source

  Returns a region of memory "after the last byte".

  This can be used to efficiently append bytes to the string buffer. The memory may not be initialized.

• fn is_empty(self: &StringBuf) -> bool

  source

  Returns true if the string buffer is empty, false otherwise.

• fn clear(self: &mut StringBuf)

  source

  Clear the string buffer, removing all bytes.

  Does not remove excess capacity, call shrink_to_fit afterwards, if this is desired.

• fn truncate(self: &mut StringBuf, new_size: usize)

  source

  Truncate the string buffer, removing all but the first new_size bytes.

  new_size should not be greater than the current capacity of the string buffer, but it may be greater than the current length of the string buffer. In this case the string buffer will grow to the specified capacity.

  str.truncate(0) is equivalent to str.clear().

• fn iter(self: &StringBuf) -> SliceIterator<&u8>

  source

  Returns an iterator over the elements of this iterable.

  See Iterable for details.

• fn iter_ref(self: &StringBuf) -> SliceRefIterator<&u8>

  source

  Returns an iterator over the pointers of the items of this iterable.

  See IterableRef for details.

• fn iter_mut(self: &mut StringBuf) -> SliceRefIterator<&mut u8>

  source

  Returns an iterator over mutable pointers to the elements of the collection.

  See IterableMut for details.

• fn shrink_to_fit(self: &mut StringBuf)

  source

  Shrink the underlying buffer to the length of the string buffer.

• fn free(self: &mut StringBuf)

  source

  Frees the memory backing the object.

• fn move(self: &mut StringBuf) -> StringBuf

  source

  Creates a copy of the object, leaving an inert object behind.

  See Movable for details.

• fn clone(self: &StringBuf) -> StringBuf

  source

  Returns a copy of the object.

• fn write_str(self: &mut StringBuf, buf: &[u8]) -> Result<(), Error>

  source

  Write a string

• fn write_byte(self: &mut StringBuf, c: u8) -> Result<(), Error>

  source

  Write a single character

• fn fmt<F>(self: &StringBuf, fmt: &mut F) -> Result<(), Error>

  F: Formatter<F>

  source

  Write the object into a given formatter.

  See Formattable for details.

• fn equals(self: &StringBuf, other: &StringBuf) -> bool

  source

  Returns true if arguments are equal, false otherwise

  See Equatable for details.

• fn compare(self: &StringBuf, other: &StringBuf) -> Ordering

  source

  Compare the value

  See Comparable for details.

• fn hash<H>(self: &StringBuf, state: &mut H)

  H: Hasher<H>

  source

  Update hasher state with the contents of this object.

  See Hashable for details.

• fn borrow(self: &StringBuf) -> &[u8]

  source

  Returns a view to the object.

• fn borrow_mut(self: &mut StringBuf) -> &mut [u8]

  source

  Returns a mutable view to the object.

Mixins

• mixin Equatable<StringBuf>

• fn not_equals(lhs: &Self, rhs: &Self) -> bool

  source

  Returns false if arguments are equal, true otherwise

• mixin Comparable<StringBuf>

• fn less_than(lhs: &Self, rhs: &Self) -> bool

  source

  Returns true if lhs is strictly less than rhs, false otherwise

• fn less_than_or_equal(lhs: &Self, rhs: &Self) -> bool

  source

  Returns true if lhs is less or equal to rhs, false otherwise

• fn greater_than(lhs: &Self, rhs: &Self) -> bool

  source

  Returns true if lhs strictly greater than rhs, false otherwise

• fn greater_than_or_equal(lhs: &Self, rhs: &Self) -> bool

  source

  Returns true if lhs greater than or equal rhs, false otherwise

• mixin<H> Hashable<StringBuf, H>

  H: Hasher<H>