Struct FsStr

Source

pub struct FsStr { /* private fields */ }

Expand description

Borrowed reference to an VEXos filesystem OS string.

This type represents a borrowed reference to a string in VEXos’s preferred representation for filesystem paths.

Implementations§

Source §

impl FsStr

Source

pub fn new<'a, S: AsRef<Self> + 'a>(string: S) -> &'a Self

Coerces into an OsStr slice.

§Examples

use vexide::fs::FsStr;

let fs_str = FsStr::new("foo");

Source

pub const unsafe fn from_encoded_bytes_unchecked(bytes: &[u8]) -> &Self

Converts a slice of bytes to an FS string slice without checking that the string contains valid FsStr-encoded data.

§Safety

As the encoding is unspecified, callers must pass in bytes that originated as a mixture of validated UTF-8 and bytes from FsStr::as_encoded_bytes from within the same Rust version built for the same target platform.

Due to the encoding being self-synchronizing, the bytes from FsStr::as_encoded_bytes can be split either immediately before or immediately after any valid non-empty UTF-8 substring.

Source

pub const fn as_encoded_bytes(&self) -> &[u8]

Converts an FS string slice to a byte slice. To convert the byte slice back into an FS string slice, use the FsStr::from_encoded_bytes_unchecked function.

§Note

As the encoding is unspecified, any sub-slice of bytes that is not valid UTF-8 should be treated as opaque and only comparable within the same Rust version built for the same target platform. For example, sending the slice over the network or storing it in a file will likely result in incompatible byte slices.

Source

pub fn to_fs_string(&self) -> FsString

Copies this FsStr into an owned FsString.

§Examples

let fs_str = FsStr::new("foo");
let fs_string = fs_str.to_fs_string();
assert_eq!(ofs_string.as_encoded_bytes(), fs_str.as_encoded_bytes());

Source

pub fn to_string_lossy(&self) -> Cow<'_, str>

Converts an FsStr into a UTF-8 encoded string.

Any non-UTF-8 sequences are replaced with the unicode U+FFFD REPLACEMENT CHARACTER.

Source

pub const fn is_empty(&self) -> bool

Checks whether or not the FsStr is empty.

§Examples

let fs_str = FsStr::new("");
assert!(fs_str.is_empty());

let fs_str = FsStr::new("foo");
assert!(!fs_str.is_empty());

Source

pub const fn len(&self) -> usize

Returns the length of the FsStr.

§Examples

let fs_str = FsStr::new("");
assert_eq!(fs_str.len(), 0);

let fs_str = FsStr::new("foo");
assert_eq!(fs_str.len(), 3);

Source

pub const fn display(&self) -> Display<'_>

Returns a Display which can be used to display FsStrs that may contain non-UTF-8 data. This may perform lossy conversions. For an implementation that escapes the data, use Debug.