Enum object_store::ObjectStoreScheme

#[non_exhaustive]
pub enum ObjectStoreScheme {
    Local,
    Memory,
    AmazonS3,
    GoogleCloudStorage,
    MicrosoftAzure,
    Http,
}

Recognizes various URL formats, identifying the relevant ObjectStore

See ObjectStoreScheme::parse for more details

Supported formats:

• file:///path/to/my/file -> LocalFileSystem
• memory:/// -> InMemory
• s3://bucket/path -> AmazonS3 (also supports s3a)
• gs://bucket/path -> GoogleCloudStorage
• az://account/container/path -> MicrosoftAzure (also supports adl, azure, abfs, abfss)
• http://mydomain/path -> HttpStore
• https://mydomain/path -> HttpStore

There are also special cases for AWS and Azure for https://{host?}/path paths:

• dfs.core.windows.net, blob.core.windows.net, dfs.fabric.microsoft.com, blob.fabric.microsoft.com -> MicrosoftAzure
• amazonaws.com -> AmazonS3
• r2.cloudflarestorage.com -> AmazonS3

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Local

Url corresponding to LocalFileSystem

Memory

Url corresponding to InMemory

AmazonS3

Url corresponding to AmazonS3

GoogleCloudStorage

Url corresponding to GoogleCloudStorage

MicrosoftAzure

Url corresponding to MicrosoftAzure

Http

Url corresponding to HttpStore

Implementations

impl ObjectStoreScheme

pub fn parse(url: &Url) -> Result<(Self, Path), Error>

Create an ObjectStoreScheme from the provided Url

Returns the ObjectStoreScheme and the remaining Path

Example

let url: Url = "file:///path/to/my/file".parse().unwrap();
let (scheme, path) = ObjectStoreScheme::parse(&url).unwrap();
assert_eq!(scheme, ObjectStoreScheme::Local);
assert_eq!(path.as_ref(), "path/to/my/file");

let url: Url = "https://blob.core.windows.net/path/to/my/file".parse().unwrap();
let (scheme, path) = ObjectStoreScheme::parse(&url).unwrap();
assert_eq!(scheme, ObjectStoreScheme::MicrosoftAzure);
assert_eq!(path.as_ref(), "path/to/my/file");

let url: Url = "https://example.com/path/to/my/file".parse().unwrap();
let (scheme, path) = ObjectStoreScheme::parse(&url).unwrap();
assert_eq!(scheme, ObjectStoreScheme::Http);
assert_eq!(path.as_ref(), "path/to/my/file");

Trait Implementations

impl Clone for ObjectStoreScheme

fn clone(&self) -> ObjectStoreScheme

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectStoreScheme

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

Formats the value using the given formatter.

impl PartialEq for ObjectStoreScheme

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

impl StructuralPartialEq for ObjectStoreScheme