Struct wick_package::WickPackage

pub struct WickPackage { /* private fields */ }

Represents a Wick package, including its files and metadata.

Implementations

impl WickPackage

pub async fn from_path( basedir: Option<PathBuf>, path: &Path ) -> Result<Self, Error>

Creates a new WickPackage from the provided path.

The provided path can be a file or directory. If it is a directory, the WickPackage will be created based on the files within the directory.

pub fn list_files(&self) -> Vec<&PackageFile>

Returns a list of the files contained within the WickPackage.

pub const fn basedir(&self) -> Option<&PathBuf>

Return the base directory of the WickPackage if it came from the filesystem.

pub const fn path(&self) -> &PathBuf

Returns a list of the files contained within the WickPackage.

pub fn registry_reference(&self) -> Option<String>

Returns the reference.

pub fn tagged_reference(&self, tag: &str) -> Option<String>

Returns an OCI URL with the specified tag.

pub const fn registry(&self) -> Option<&RegistryConfig>

Returns the registry configuration.

pub fn registry_mut(&mut self) -> Option<&mut RegistryConfig>

Returns a mutable reference to registry configuration.

pub async fn push( &mut self, reference: &str, options: &OciOptions ) -> Result<String, Error>

Pushes the WickPackage to a specified registry using the provided reference, username, and password.

The username and password are optional. If not provided, the function falls back to anonymous authentication.

pub async fn pull(reference: &str, options: &OciOptions) -> Result<Self, Error>

This function pulls a WickPackage from a specified registry using the provided reference, username, and password.

Trait Implementations

impl Clone for WickPackage

fn clone(&self) -> WickPackage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WickPackage

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

Formats the value using the given formatter.