Skip to main content

Registry

Struct Registry 

Source
pub struct Registry { /* private fields */ }
Expand description

A dataset registry for publishing and retrieving datasets.

The registry stores datasets along with metadata in a structured format, enabling discovery and versioning of datasets.

§Example

use alimentar::{backend::MemoryBackend, registry::Registry};

let backend = MemoryBackend::new();
let registry = Registry::new(Box::new(backend));

Implementations§

Source§

impl Registry

Source

pub fn new(backend: Box<dyn StorageBackend>) -> Self

Creates a new registry with the given storage backend.

Source

pub fn with_index_path( backend: Box<dyn StorageBackend>, index_path: impl Into<String>, ) -> Self

Creates a new registry with a custom index path.

Source

pub fn init(&self) -> Result<()>

Initializes the registry by creating an empty index if one doesn’t exist.

§Errors

Returns an error if the index cannot be created.

Source

pub fn load_index(&self) -> Result<RegistryIndex>

Loads the registry index.

§Errors

Returns an error if the index cannot be loaded or parsed.

Source

pub fn list(&self) -> Result<Vec<DatasetInfo>>

Lists all available datasets in the registry.

§Errors

Returns an error if the index cannot be loaded.

Source

pub fn get_info(&self, name: &str) -> Result<DatasetInfo>

Gets information about a specific dataset.

§Errors

Returns an error if the dataset is not found.

Source

pub fn publish( &self, name: &str, version: &str, dataset: &ArrowDataset, metadata: DatasetMetadata, ) -> Result<()>

Publishes a dataset to the registry.

§Arguments
  • name - Unique name for the dataset
  • version - Semantic version string (e.g., “1.0.0”)
  • dataset - The dataset to publish
  • metadata - Metadata describing the dataset
§Errors

Returns an error if the dataset cannot be saved or the index cannot be updated.

Source

pub fn pull(&self, name: &str, version: Option<&str>) -> Result<ArrowDataset>

Pulls a dataset from the registry.

§Arguments
  • name - Name of the dataset
  • version - Optional version (uses latest if not specified)
§Errors

Returns an error if the dataset cannot be found or loaded.

Source

pub fn search(&self, query: &str) -> Result<Vec<DatasetInfo>>

Searches datasets by query string (matches name and description).

§Errors

Returns an error if the index cannot be loaded.

Source

pub fn search_tags(&self, tags: &[&str]) -> Result<Vec<DatasetInfo>>

Searches datasets by tags.

§Errors

Returns an error if the index cannot be loaded.

Source

pub fn delete(&self, name: &str, version: &str) -> Result<()>

Deletes a dataset version from the registry.

§Errors

Returns an error if the dataset cannot be deleted.

Trait Implementations§

Source§

impl Debug for Registry

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more