Struct datafusion_execution::object_store::ObjectStoreUrl

pub struct ObjectStoreUrl { /* private fields */ }

A parsed URL identifying a particular ObjectStore instance

For example:

• file:// for local file system
• s3://bucket for AWS S3 bucket
• oss://bucket for Aliyun OSS bucket

Implementations

impl ObjectStoreUrl

pub fn parse(s: impl AsRef<str>) -> Result<Self>

Parse an ObjectStoreUrl from a string

Example

let object_store_url = ObjectStoreUrl::parse("s3://bucket").unwrap();
assert_eq!(object_store_url.as_str(), "s3://bucket/");
// can also access the underlying `Url`
let url: &Url = object_store_url.as_ref();
assert_eq!(url.scheme(), "s3");
assert_eq!(url.host_str(), Some("bucket"));
assert_eq!(url.path(), "/");

pub fn local_filesystem() -> Self

An ObjectStoreUrl for the local filesystem (file://)

Example

let local_fs = ObjectStoreUrl::parse("file://").unwrap();
assert_eq!(local_fs, ObjectStoreUrl::local_filesystem())

pub fn as_str(&self) -> &str

Returns this ObjectStoreUrl as a string

Trait Implementations

impl AsRef<Url> for ObjectStoreUrl

fn as_ref(&self) -> &Url

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

impl AsRef<str> for ObjectStoreUrl

fn as_ref(&self) -> &str

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

impl Clone for ObjectStoreUrl

fn clone(&self) -> ObjectStoreUrl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectStoreUrl

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

Formats the value using the given formatter.

impl Display for ObjectStoreUrl

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

Formats the value using the given formatter.

impl Hash for ObjectStoreUrl

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 Ord for ObjectStoreUrl

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

Restrict a value to a certain interval.

impl PartialEq for ObjectStoreUrl

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

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

impl StructuralPartialEq for ObjectStoreUrl