Struct c_utf8::CUtf8Buf

pub struct CUtf8Buf(_);

An owned, mutable UTF-8 encoded C string (akin to String or PathBuf).

Examples

This type retains certain behaviors that are expected from String such as calling .collect() on iterators.

use c_utf8::CUtf8Buf;

let strings = vec![
    "Hello ",
    "there, ",
    "fellow ",
    "human!"
];

let joined = strings.into_iter().collect::<CUtf8Buf>();
let bytes  = joined.as_bytes_with_nul();

assert_eq!(bytes, b"Hello there, fellow human!\0");

Methods

impl CUtf8Buf

pub fn new() -> CUtf8Buf

Creates a new empty CUtf8Buf.

pub fn from_string(s: String) -> CUtf8Buf

Creates a new C string from a UTF-8 string, appending a nul terminator if one doesn't already exist.

pub unsafe fn from_string_unchecked(s: String) -> CUtf8Buf

Creates a new C string from a native Rust string without checking for a nul terminator.

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

Appends a given string slice onto the end of this CUtf8Buf.

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

Appends the given char to the end of this CUtf8Buf.

pub fn into_string(self) -> String

Converts self into a native UTF-8 encoded Rust String.

Important traits for Vec<u8>

impl Write for Vec<u8>

pub fn into_bytes(self) -> Vec<u8>

Converts self into its underlying bytes.

Methods from Deref<Target = CUtf8>

pub const EMPTY: &'static CUtf8

pub fn len(&self) -> usize

Returns the number of bytes without taking into account the trailing nul byte.

This behavior is the same as that of str::len where the length is not measured in chars.

Examples

Basic usage:

let s = c_utf8!("Hey");

assert_eq!(s.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if self contains 0 bytes, disregarding the trailing nul byte.

Examples

Basic usage:

let s = c_utf8::CUtf8::EMPTY;

assert!(s.is_empty());
assert_eq!(s.len(), 0);

pub fn as_ptr(&self) -> *const c_char

Returns a pointer to the start of the raw C string.

pub fn as_c_str(&self) -> &CStr

Returns self as a normal C string.

pub fn as_str(&self) -> &str

Returns self as a normal UTF-8 encoded string.

pub fn as_str_with_nul(&self) -> &str

Returns self as a UTF-8 encoded string with a trailing 0 byte.

Important traits for &'a [u8]

impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]

pub fn as_bytes(&self) -> &[u8]

Returns the bytes of self without a trailing 0 byte.

Important traits for &'a [u8]

impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]

pub fn as_bytes_with_nul(&self) -> &[u8]

Returns the bytes of self with a trailing 0 byte.

Trait Implementations

impl Clone for CUtf8Buf

fn clone(&self) -> CUtf8Buf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for CUtf8Buf

fn eq(&self, other: &CUtf8Buf) -> bool

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

fn ne(&self, other: &CUtf8Buf) -> bool

This method tests for !=.

impl Eq for CUtf8Buf

impl Hash for CUtf8Buf

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where     H: Hasher,

Feeds a slice of this type into the given [Hasher].

impl PartialOrd for CUtf8Buf

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

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

fn lt(&self, other: &CUtf8Buf) -> bool

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

fn le(&self, other: &CUtf8Buf) -> bool

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

fn gt(&self, other: &CUtf8Buf) -> bool

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

fn ge(&self, other: &CUtf8Buf) -> bool

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

impl Ord for CUtf8Buf

fn cmp(&self, other: &CUtf8Buf) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl PartialEq<CUtf8> for CUtf8Buf

fn eq(&self, other: &CUtf8) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<CUtf8Buf> for CUtf8

fn eq(&self, other: &CUtf8Buf) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Default for CUtf8Buf

fn default() -> CUtf8Buf

Returns the "default value" for a type.

impl Deref for CUtf8Buf

type Target = CUtf8

The resulting type after dereferencing.

fn deref(&self) -> &CUtf8

Dereferences the value.

impl DerefMut for CUtf8Buf

fn deref_mut(&mut self) -> &mut CUtf8

Mutably dereferences the value.

impl<T> FromIterator<T> for CUtf8Buf where     String: FromIterator<T>,

fn from_iter<I: IntoIterator<Item = T>>(it: I) -> CUtf8Buf

Creates a value from an iterator.

impl Debug for CUtf8Buf

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

Formats the value using the given formatter.

impl Display for CUtf8Buf

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

Formats the value using the given formatter.

impl Write for CUtf8Buf

fn write_str(&mut self, s: &str) -> Result

Writes a slice of bytes into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result

Writes a [char] into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments) -> Result

Glue for usage of the [write!] macro with implementors of this trait.

impl Borrow<CUtf8> for CUtf8Buf

fn borrow(&self) -> &CUtf8

Immutably borrows from an owned value.

impl BorrowMut<CUtf8> for CUtf8Buf

fn borrow_mut(&mut self) -> &mut CUtf8

Mutably borrows from an owned value.

impl AsRef<CUtf8> for CUtf8Buf

fn as_ref(&self) -> &CUtf8

Performs the conversion.

impl AsMut<CUtf8> for CUtf8Buf

fn as_mut(&mut self) -> &mut CUtf8

Performs the conversion.

impl<'a> From<&'a CUtf8> for CUtf8Buf

fn from(c: &CUtf8) -> CUtf8Buf

Performs the conversion.

impl<'a> From<&'a mut CUtf8> for CUtf8Buf

fn from(c: &mut CUtf8) -> CUtf8Buf

Performs the conversion.

impl From<String> for CUtf8Buf

fn from(s: String) -> CUtf8Buf

Performs the conversion.

impl<'a> From<&'a str> for CUtf8Buf

fn from(s: &str) -> CUtf8Buf

Performs the conversion.

impl<'a> From<&'a mut str> for CUtf8Buf

fn from(c: &mut str) -> CUtf8Buf

Performs the conversion.

impl From<Box<CUtf8>> for CUtf8Buf

fn from(b: Box<CUtf8>) -> CUtf8Buf

Performs the conversion.

impl From<CUtf8Buf> for Box<CUtf8>

Important traits for Box<R>

impl<R> Read for Box<R> where
    R: Read + ?Sized, impl<W> Write for Box<W> where
    W: Write + ?Sized, impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn from(buf: CUtf8Buf) -> Box<CUtf8>

Performs the conversion.

impl From<CUtf8Buf> for String

fn from(buf: CUtf8Buf) -> String

Performs the conversion.

impl From<CUtf8Buf> for Vec<u8>

Important traits for Vec<u8>

impl Write for Vec<u8>

fn from(buf: CUtf8Buf) -> Vec<u8>

Performs the conversion.