use std::borrow::Borrow; use std::fmt; use std::hash::{Hash, Hasher}; use std::mem; use std::ops::{Deref, DerefMut}; use std::str; use std::slice; use array::Array; use array::Index; use CapacityError; /// 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. #[derive(Copy)] pub struct ArrayString> { xs: A, len: A::Index, } impl> ArrayString { /// 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 new() -> ArrayString { unsafe { ArrayString { xs: ::new_array(), len: Index::from(0), } } } /// Create a new `ArrayString` from a `str`. /// /// Capacity is inferred from the type parameter. /// /// ``` /// 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(s: &str) -> Result> { let mut arraystr = Self::new(); try!(arraystr.push_str(s)); Ok(arraystr) } /// Return the capacity of the `ArrayString`. /// /// ``` /// use arrayvec::ArrayString; /// /// let string = ArrayString::<[_; 3]>::new(); /// assert_eq!(string.capacity(), 3); /// ``` #[inline] pub fn capacity(&self) -> usize { A::capacity() } /// Adds the given char to the end of the string. /// /// Returns `Ok` if the push succeeds, and returns `Err` 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').unwrap(); /// string.push('b').unwrap(); /// let overflow = string.push('c'); /// /// assert_eq!(&string[..], "ab"); /// assert_eq!(overflow.unwrap_err().element(), 'c'); /// ``` pub fn push(&mut self, c: char) -> Result<(), CapacityError> { use std::fmt::Write; self.write_char(c).map_err(|_| CapacityError::new(c)) } /// Adds the given string slice to the end of the string. /// /// Returns `Ok` if the push succeeds, and returns `Err` 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").unwrap(); /// let overflow1 = string.push_str("bc"); /// string.push_str("d").unwrap(); /// let overflow2 = string.push_str("ef"); /// /// assert_eq!(&string[..], "ad"); /// assert_eq!(overflow1.unwrap_err().element(), "bc"); /// assert_eq!(overflow2.unwrap_err().element(), "ef"); /// ``` pub fn push_str<'a>(&mut self, s: &'a str) -> Result<(), CapacityError<&'a str>> { use std::io::Write; if s.len() > self.capacity() - self.len() { return Err(CapacityError::new(s)); } unsafe { let sl = slice::from_raw_parts_mut(self.xs.as_mut_ptr(), A::capacity()); (&mut sl[self.len()..]).write(s.as_bytes()).unwrap(); let newl = self.len() + s.len(); self.set_len(newl); } Ok(()) } /// Make the string empty. pub fn clear(&mut self) { unsafe { self.set_len(0); } } /// Set the strings's length. /// /// May panic if `length` is greater than the capacity. /// /// This function is `unsafe` because it changes the notion of the /// number of “valid” bytes in the string. Use with care. #[inline] pub unsafe fn set_len(&mut self, length: usize) { debug_assert!(length <= self.capacity()); self.len = Index::from(length); } } impl> Deref for ArrayString { type Target = str; #[inline] fn deref(&self) -> &str { unsafe { let sl = slice::from_raw_parts(self.xs.as_ptr(), self.len.to_usize()); str::from_utf8_unchecked(sl) } } } impl> DerefMut for ArrayString { #[inline] fn deref_mut(&mut self) -> &mut str { unsafe { let sl = slice::from_raw_parts_mut(self.xs.as_mut_ptr(), self.len.to_usize()); // FIXME: Nothing but transmute to do this right now mem::transmute(sl) } } } impl> PartialEq for ArrayString { fn eq(&self, rhs: &Self) -> bool { **self == **rhs } } impl> PartialEq for ArrayString { fn eq(&self, rhs: &str) -> bool { &**self == rhs } } impl> PartialEq> for str { fn eq(&self, rhs: &ArrayString) -> bool { self == &**rhs } } impl> Eq for ArrayString { } impl> Hash for ArrayString { fn hash(&self, h: &mut H) { (**self).hash(h) } } impl> Borrow for ArrayString { fn borrow(&self) -> &str { self } } impl> AsRef for ArrayString { fn as_ref(&self) -> &str { self } } impl> fmt::Debug for ArrayString { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { (**self).fmt(f) } } impl> fmt::Display for ArrayString { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { (**self).fmt(f) } } /// `Write` appends written data to the end of the string. impl> fmt::Write for ArrayString { fn write_str(&mut self, s: &str) -> fmt::Result { self.push_str(s).map_err(|_| fmt::Error) } } impl + Copy> Clone for ArrayString { fn clone(&self) -> ArrayString { *self } fn clone_from(&mut self, rhs: &Self) { // guaranteed to fit due to types matching. self.clear(); self.push_str(rhs).ok(); } }