Struct PlRefPath 

pub struct PlRefPath { /* private fields */ }

Reference-counted PlPath.

Windows paths invariant

Windows paths will have leading \\?\ prefix stripped, and all backslashes normalized to forward slashes.

Implementations

impl PlRefPath

pub fn empty() -> Self

pub fn new(path: impl AsRef<str> + Into<PlRefStr>) -> Self

Normalizes Windows paths.

pub fn try_from_path(path: &Path) -> PolarsResult<PlRefPath>

pub fn try_from_pathbuf(path: PathBuf) -> PolarsResult<PlRefPath>

pub fn as_str(&self) -> &str

pub fn as_ref_str(&self) -> &PlRefStr

pub fn into_ref_str(self) -> PlRefStr

pub fn sliced(&self, range: Range<usize>) -> PlRefPath

Slices the path.

pub fn to_absolute_path(&self) -> PolarsResult<Cow<'_, PlRefPath>>

Returns

Returns an absolute local path if this path ref is a relative local path, otherwise returns None.

pub fn ptr_eq(this: &Self, other: &Self) -> bool

Checks if references point to the same allocation.

Methods from Deref<Target = PlPath>

pub fn as_str(&self) -> &str

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

pub fn as_os_str(&self) -> &OsStr

pub fn as_std_path(&self) -> &Path

pub fn to_ref_path(&self) -> PlRefPath

pub fn scheme(&self) -> Option<CloudScheme>

pub fn has_scheme(&self) -> bool

Shorthand for self.scheme().is_some().

pub fn strip_scheme(&self) -> &str

Return a string with the scheme prefix removed (if any).

pub fn file_name(&self) -> Option<&OsStr>

pub fn extension(&self) -> Option<&str>

pub fn parent(&self) -> Option<&str>

pub fn sliced(&self, range: Range<usize>) -> &PlPath

Slices the path.

pub fn strip_scheme_split_authority(&self) -> Option<(&str, &str)>

Strips the scheme, then returns the authority component, and the remaining string after the authority component. This can be understood as extracting the bucket/prefix for cloud URIs.

E.g. https://user@host:port/dir/file?param=value

• Authority: user@host:port
• Remaining: /dir/file?param=value

Note, for local / file: URIs, the returned authority will be empty, and the remainder will be the full URI.

Returns

(authority, remaining).

pub fn authority_end_position(&self) -> usize

Returns 0 if self.scheme() is None. Otherwise, returns i such that &self.to_str()[..i] trims to the authority.

• If there is no ‘/’, separator found, i will simply be the length of the string.
  • This is except if the scheme is FileNoHostname, where instead i will be “file:”.len()
• If self has no CloudScheme, returns 0

pub fn to_absolute_path(&self) -> PolarsResult<PlRefPath>

pub fn join(&self, other: impl AsRef<str>) -> PlRefPath

Trait Implementations

impl AsRef<OsStr> for PlRefPath

fn as_ref(&self) -> &OsStr

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Path> for PlRefPath

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for PlRefPath

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<PlPath> for PlRefPath

fn borrow(&self) -> &PlPath

Immutably borrows from an owned value.

impl Clone for PlRefPath

fn clone(&self) -> PlRefPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlRefPath

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

Formats the value using the given formatter.

impl Default for PlRefPath

fn default() -> PlRefPath

Returns the “default value” for a type.

impl Deref for PlRefPath

type Target = PlPath

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for PlRefPath

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PlRefPath

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

Formats the value using the given formatter.

impl From<&str> for PlRefPath

fn from(value: &str) -> Self

Converts to this type from the input type.

impl Hash for PlRefPath

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for PlRefPath

Available on crate feature dsl-schema only.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn always_inline_schema() -> bool

👎Deprecated: Use inline_schema() instead

Only included for backward-compatibility - use inline_schema() instead“.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for PlRefPath

fn cmp(&self, other: &PlRefPath) -> 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 PlRefPath

fn eq(&self, other: &PlRefPath) -> 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 PlRefPath

fn partial_cmp(&self, other: &PlRefPath) -> 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 Serialize for PlRefPath

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PlRefPath

impl StructuralPartialEq for PlRefPath