Struct palletizer::Registry

pub struct Registry { /* fields omitted */ }

Implementations

impl Registry

pub fn init(path: impl AsRef<Path>, config: Config) -> Result<Self, Error>

Initialize a new registry with a config file.

pub fn open(path: impl AsRef<Path>) -> Result<Self, Error>

Open an existing registry.

pub fn path(&self) -> &Path

Get the path of the registry.

pub fn index_repo(&self) -> &Repository

Get the git repository of the index.

pub fn index_dir(&self) -> PathBuf

Get the absolute path of the index repository.

pub fn crate_dir(&self) -> PathBuf

Get the absolute path of the crate directory.

pub fn read_index(&self, crate_name: &str) -> Result<Vec<Entry>, Error>

Read the index entries for a specific crate.

pub fn iter_crate_names(&self) -> impl Iterator<Item = Result<String, Error>>

Iterate over the names of all crates in the registry.

pub fn add_crate_with_metadata(
    &mut self,
    metadata: &Entry,
    data: &[u8]
) -> Result<(), Error>

Add a crate to the registry using the supplied metadata.

pub fn add_crate(&mut self, data: &[u8]) -> Result<(), Error>

Add a crate to the registry.

You must pass the path to a crate as packaged by cargo package.

pub fn add_crate_from_file(
    &mut self,
    path: impl AsRef<Path>
) -> Result<(), Error>

Add a crate to the registry.

You must pass the path to a crate as packaged by cargo package.

pub fn delete_crate(&mut self, name: &str) -> Result<(), Error>

Delete a crate from the registry.

This will completely remove the index entry and the crate files. Normally, you should yank a crate with [Self::yank-crate()] instead of deleting it.

pub fn yank_crate(&mut self, name: &str, version: &str) -> Result<bool, Error>

Yank a crate from the registry.

Returns true if the crate was yanked, and false if the crate was already yanked.

If the crate is not found or if an other error occures, an error is returned.

pub fn unyank_crate(&mut self, name: &str, version: &str) -> Result<bool, Error>

Unyank a crate from the registry.

Returns true if the crate was unyanked, and false if the crate was already unyanked.

If the crate is not found or if an other error occures, an error is returned.

Trait Implementations

impl Sync for Registry