Interface Arg

src/path/arg.rs:68–93

A trait for passing path arguments. This is similar to [`AsRef`]`<`[`Path`]`>`, but is implemented for more kinds of strings and can convert into more kinds of strings. # Examples ``` # #[cfg(any(feature = "fs", feature = "net"))] use rustix::ffi::CStr; use rustix::io; # #[cfg(any(feature = "fs", feature = "net"))] use rustix::path::Arg; # #[cfg(any(feature = "fs", feature = "net"))] pub fn to

///
/// [`AsRef`]: std::convert::AsRef
pub trait Arg {
    /// Returns a view of this string as a string slice.
    fn as_str(&self) -> io::Result<&str>;

    /// Returns a potentially-lossy rendering of this string as a
    /// `Cow<'_, str>`.
    #[cfg(feature = "alloc")]
    fn to_string_lossy(&self) -> Cow<'_, str>;

    /// Returns a view of this string as a maybe-owned [`CStr`].
    #[cfg(feature = "alloc")]
    fn as_cow_c_str(&self) -> io::Result<Cow<'_, CStr>>;

    /// Consumes `self` and returns a view of this string as a maybe-owned
    /// [`CStr`].
    #[cfg(feature = "alloc")]
    fn into_c_str<'b>(self) -> io::Result<Cow<'b, CStr>>
    where
        Self: 'b;

    /// Runs a closure with `self` passed in as a `&CStr`.
    fn into_with_c_str<T, F>(self, f: F) -> io::Result<T>
    where
        Self: Sized,
        F: FnOnce(&CStr) -> io::Result<T>;
}

/// Runs a closure on `arg` where `A` is mapped to a `&CStr`
pub fn option_into_with_c_str<T, F, A>(arg: Option<A>, f: F) -> io::Result<T>