Struct ObsPath

pub struct ObsPath { /* private fields */ }

Builds into an ObsString that represents a path used by libobs.

Note that only this path only supports UTF-8 for the entire absolute path because libobs only supports UTF-8.

Implementations

impl ObsPath

pub fn new(path_str: &str) -> Self

Creates a new ObsPath strictly using the path path_str without any modifications.

If you want to create a relative path, use ObsPath::from_relative.

pub fn from_relative(path_str: &str) -> Self

Creates a new ObsPath with path_str appended to the path of the directory which the executable file is in.

If you want to create an absolute path, use ObsPath::new.

pub fn push(self, value: &str) -> Self

Modifies the path to point to the path path_str appended to the current path which ObsPath is pointing to.

pub fn pop(self) -> Self

Modifies the path to point to its current parent. This is analogous to Obs::push(".").

pub fn build(self) -> ObsString

Consumes the ObsPath to create a new immutable ObsString that encodes a UTF-8 C-type string which describes the path that the ObsPath is pointing to.

Note that this function is lossy in that any non-Unicode data is completely removed from the string. This is because libobs does not support non-Unicode characters in its path.

Trait Implementations

impl Clone for ObsPath

fn clone(&self) -> ObsPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ObsPath

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

Formats the value using the given formatter.

impl Default for ObsPath

fn default() -> ObsPath

Returns the “default value” for a type.

impl Into<ObsString> for ObsPath

fn into(self) -> ObsString

Converts this type into the (usually inferred) input type.

impl Ord for ObsPath

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ObsPath

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ObsPath

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for ObsPath

impl StructuralPartialEq for ObsPath