Struct arccstr::ArcCStr
[−]
[src]
pub struct ArcCStr { /* fields omitted */ }
A thread-safe reference-counted null-terminated string.
The type ArcCStr
provides shared ownership of a C-style null-terminated string allocated in
the heap. Invoking clone
on ArcCStr
produces a new pointer to the same value in the heap.
When the last ArcCStr
pointer to a given string is destroyed, the pointed-to string is also
destroyed. Behind the scenes, ArcCStr
works much like Arc
.
Strings pointed to using ArcCStr
are meant to be immutable, and there therefore no
mechanism is provided to get a mutable reference to the underlying string, even if there are no
other pointers to the string in question.
ArcCStr
uses atomic operations for reference counting, so ArcCStr
s can be sent freely
between threads. In other words, ArcCStr
implements cheap Send
for strings using the fact
that CStr
is Sync
. ArcCStr
tries to minimize the space overhead of this feature by
sharing the string data. The disadvantage of this approach is that it requires atomic
operations that are more expensive than ordinary memory accesses. Thus, if you have many
threads accessing the same data, you may see contention. However, in the common case, using
ArcCStr
should still be faster than cloning the full string.
ArcCStr
automatically dereferences to CStr
(via the Deref
trait), so you can call
CStr
's methods on a value of type ArcCStr
. To avoid name clashes with CStr
's methods,
the methods of ArcCStr
itself are associated functions, called using function-like
syntax:
#![feature(try_from)] use arccstr::ArcCStr; use std::convert::TryFrom; let mut my_arc = ArcCStr::try_from("foobar").unwrap(); ArcCStr::strong_count(&my_arc);
Examples
Sharing some immutable strings between threads:
#![feature(try_from)] use std::convert::TryFrom; use arccstr::ArcCStr; use std::thread; let five = ArcCStr::try_from("5").unwrap(); for _ in 0..10 { let five = five.clone(); thread::spawn(move || { println!("{:?}", five); }); }
Methods
impl ArcCStr
[src]
pub fn strong_count(this: &Self) -> usize
[src]
Gets the number of pointers to this string.
Safety
This method by itself is safe, but using it correctly requires extra care. Another thread can change the strong count at any time, including potentially between calling this method and acting on the result.
Examples
#![feature(try_from)] use std::convert::TryFrom; use arccstr::ArcCStr; let five = ArcCStr::try_from("5").unwrap(); let _also_five = five.clone(); // This assertion is deterministic because we haven't shared // the `ArcCStr` between threads. assert_eq!(2, ArcCStr::strong_count(&five));
pub fn ptr_eq(this: &Self, other: &Self) -> bool
[src]
Returns true if the two ArcCStr
s point to the same value (not
just values that compare as equal).
Examples
#![feature(try_from)] use std::convert::TryFrom; use arccstr::ArcCStr; let five = ArcCStr::try_from("5").unwrap(); let same_five = five.clone(); let other_five = ArcCStr::try_from("5").unwrap(); assert!(ArcCStr::ptr_eq(&five, &same_five)); assert!(!ArcCStr::ptr_eq(&five, &other_five));
Methods from Deref<Target = CStr>
pub fn as_ptr(&self) -> *const i8
1.0.0[src]
Returns the inner pointer to this C string.
The returned pointer will be valid for as long as self
is, and points
to a contiguous region of memory terminated with a 0 byte to represent
the end of the string.
WARNING
It is your responsibility to make sure that the underlying memory is not
freed too early. For example, the following code will cause undefined
behavior when ptr
is used inside the unsafe
block:
use std::ffi::{CString}; let ptr = CString::new("Hello").unwrap().as_ptr(); unsafe { // `ptr` is dangling *ptr; }
This happens because the pointer returned by as_ptr
does not carry any
lifetime information and the CString
is deallocated immediately after
the CString::new("Hello").unwrap().as_ptr()
expression is evaluated.
To fix the problem, bind the CString
to a local variable:
use std::ffi::{CString}; let hello = CString::new("Hello").unwrap(); let ptr = hello.as_ptr(); unsafe { // `ptr` is valid because `hello` is in scope *ptr; }
This way, the lifetime of the CString
in hello
encompasses
the lifetime of ptr
and the unsafe
block.
pub fn to_bytes(&self) -> &[u8]
1.0.0[src]
Converts this C string to a byte slice.
The returned slice will not contain the trailing nul terminator that this C string has.
Note: This method is currently implemented as a constant-time cast, but it is planned to alter its definition in the future to perform the length calculation whenever this method is called.
Examples
use std::ffi::CStr; let c_str = CStr::from_bytes_with_nul(b"foo\0").unwrap(); assert_eq!(c_str.to_bytes(), b"foo");
pub fn to_bytes_with_nul(&self) -> &[u8]
1.0.0[src]
Converts this C string to a byte slice containing the trailing 0 byte.
This function is the equivalent of to_bytes
except that it will retain
the trailing nul terminator instead of chopping it off.
Note: This method is currently implemented as a 0-cost cast, but it is planned to alter its definition in the future to perform the length calculation whenever this method is called.
Examples
use std::ffi::CStr; let c_str = CStr::from_bytes_with_nul(b"foo\0").unwrap(); assert_eq!(c_str.to_bytes_with_nul(), b"foo\0");
pub fn to_str(&self) -> Result<&str, Utf8Error>
1.4.0[src]
Yields a &str
slice if the CStr
contains valid UTF-8.
If the contents of the CStr
are valid UTF-8 data, this
function will return the corresponding &str
slice. Otherwise,
it will return an error with details of where UTF-8 validation failed.
Note: This method is currently implemented to check for validity after a constant-time cast, but it is planned to alter its definition in the future to perform the length calculation in addition to the UTF-8 check whenever this method is called.
Examples
use std::ffi::CStr; let c_str = CStr::from_bytes_with_nul(b"foo\0").unwrap(); assert_eq!(c_str.to_str(), Ok("foo"));
pub fn to_string_lossy(&self) -> Cow<str>
1.4.0[src]
Converts a CStr
into a Cow
<
str
>
.
If the contents of the CStr
are valid UTF-8 data, this
function will return a Cow
::
Borrowed
(
[&str
])
with the the corresponding [&str
] slice. Otherwise, it will
replace any invalid UTF-8 sequences with U+FFFD REPLACEMENT CHARACTER
and return a Cow
::
[Owned
](
String
)
with the result.
Note: This method is currently implemented to check for validity after a constant-time cast, but it is planned to alter its definition in the future to perform the length calculation in addition to the UTF-8 check whenever this method is called.
Examples
Calling to_string_lossy
on a CStr
containing valid UTF-8:
use std::borrow::Cow; use std::ffi::CStr; let c_str = CStr::from_bytes_with_nul(b"Hello World\0").unwrap(); assert_eq!(c_str.to_string_lossy(), Cow::Borrowed("Hello World"));
Calling to_string_lossy
on a CStr
containing invalid UTF-8:
use std::borrow::Cow; use std::ffi::CStr; let c_str = CStr::from_bytes_with_nul(b"Hello \xF0\x90\x80World\0").unwrap(); assert_eq!( c_str.to_string_lossy(), Cow::Owned(String::from("Hello �World")) as Cow<str> );
Trait Implementations
impl Send for ArcCStr
[src]
impl Sync for ArcCStr
[src]
impl<'a> TryFrom<&'a [u8]> for ArcCStr
[src]
type Error = FromBytesWithNulError
try_from
)The type returned in the event of a conversion error.
fn try_from(b: &'a [u8]) -> Result<Self, Self::Error>
[src]
try_from
)Performs the conversion.
impl<'a> TryFrom<&'a str> for ArcCStr
[src]
type Error = FromBytesWithNulError
try_from
)The type returned in the event of a conversion error.
fn try_from(s: &'a str) -> Result<Self, Self::Error>
[src]
try_from
)Performs the conversion.
impl TryFrom<String> for ArcCStr
[src]
type Error = FromBytesWithNulError
try_from
)The type returned in the event of a conversion error.
fn try_from(s: String) -> Result<Self, Self::Error>
[src]
try_from
)Performs the conversion.
impl From<CString> for ArcCStr
[src]
impl<'a> From<&'a CStr> for ArcCStr
[src]
impl Clone for ArcCStr
[src]
fn clone(&self) -> ArcCStr
[src]
Makes a clone of the ArcCStr
pointer.
This creates another pointer to the same underlying string, increasing the reference count.
Examples
#![feature(try_from)] use std::convert::TryFrom; use arccstr::ArcCStr; let five = ArcCStr::try_from("5").unwrap(); five.clone();
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Deref for ArcCStr
[src]
type Target = CStr
The resulting type after dereferencing.
fn deref(&self) -> &Self::Target
[src]
Dereferences the value.
impl Drop for ArcCStr
[src]
fn drop(&mut self)
[src]
Drops the ArcCStr
.
This will decrement the reference count. If the reference count reaches zero then we also deallocate the underlying string.
Examples
#![feature(try_from)] use std::convert::TryFrom; use arccstr::ArcCStr; let foo = ArcCStr::try_from("foo").unwrap(); let foo2 = foo.clone(); drop(foo); // "foo" is still in memory drop(foo2); // "foo" is deallocated
impl PartialEq for ArcCStr
[src]
fn eq(&self, other: &ArcCStr) -> bool
[src]
Equality for two ArcCStr
s.
Two ArcCStr
s are equal if their underlying strings are equal.
Examples
#![feature(try_from)] use std::convert::TryFrom; use arccstr::ArcCStr; let five = ArcCStr::try_from("5"); assert_eq!(five, ArcCStr::try_from("5")); assert_ne!(five, ArcCStr::try_from("6"));
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
This method tests for !=
.
impl PartialOrd for ArcCStr
[src]
fn partial_cmp(&self, other: &ArcCStr) -> Option<Ordering>
[src]
Partial comparison for two ArcCStr
s.
The two are compared by calling partial_cmp()
on their underlying strings.
Examples
#![feature(try_from)] use arccstr::ArcCStr; use std::cmp::Ordering; use std::convert::TryFrom; let five = ArcCStr::try_from("5").unwrap(); assert_eq!(Some(Ordering::Less), five.partial_cmp(&ArcCStr::try_from("6").unwrap()));
fn lt(&self, other: &ArcCStr) -> bool
[src]
Less-than comparison for two ArcCStr
s.
The two are compared by calling <
on their inner values.
Examples
#![feature(try_from)] use std::convert::TryFrom; use arccstr::ArcCStr; let five = ArcCStr::try_from("5").unwrap(); assert!(five < ArcCStr::try_from("6").unwrap());
fn le(&self, other: &ArcCStr) -> bool
[src]
'Less than or equal to' comparison for two ArcCStr
s.
The two are compared by calling <=
on their underlying strings.
Examples
#![feature(try_from)] use std::convert::TryFrom; use arccstr::ArcCStr; let five = ArcCStr::try_from("5").unwrap(); assert!(five <= ArcCStr::try_from("5").unwrap());
fn gt(&self, other: &ArcCStr) -> bool
[src]
Greater-than comparison for two ArcCStr
s.
The two are compared by calling >
on their underlying strings.
Examples
#![feature(try_from)] use std::convert::TryFrom; use arccstr::ArcCStr; let five = ArcCStr::try_from("5").unwrap(); assert!(five > ArcCStr::try_from("4").unwrap());
fn ge(&self, other: &ArcCStr) -> bool
[src]
'Greater than or equal to' comparison for two ArcCStr
s.
The two are compared by calling >=
on their underlying strings.
Examples
#![feature(try_from)] use std::convert::TryFrom; use arccstr::ArcCStr; let five = ArcCStr::try_from("5").unwrap(); assert!(five >= ArcCStr::try_from("5").unwrap());
impl Ord for ArcCStr
[src]
fn cmp(&self, other: &ArcCStr) -> Ordering
[src]
Comparison for two ArcCStr
s.
The two are compared by calling cmp()
on their underlying strings.
Examples
#![feature(try_from)] use arccstr::ArcCStr; use std::cmp::Ordering; use std::convert::TryFrom; let five = ArcCStr::try_from("5").unwrap(); assert_eq!(Ordering::Less, five.cmp(&ArcCStr::try_from("6").unwrap()));
fn max(self, other: Self) -> Self
1.21.0[src]
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
Compares and returns the minimum of two values. Read more
impl Eq for ArcCStr
[src]
impl Debug for ArcCStr
[src]
fn fmt(&self, f: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl Pointer for ArcCStr
[src]
impl Hash for ArcCStr
[src]
fn hash<H: Hasher>(&self, state: &mut H)
[src]
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl Borrow<CStr> for ArcCStr
[src]
impl AsRef<CStr> for ArcCStr
[src]
impl Serialize for ArcCStr
[src]
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,
[src]
S: Serializer,
Serialize this value into the given Serde serializer. Read more
impl<'de> Deserialize<'de> for ArcCStr
[src]
fn deserialize<D>(deserializer: D) -> Result<ArcCStr, D::Error> where
D: Deserializer<'de>,
[src]
D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more