Struct Package 

pub struct Package { /* private fields */ }

A package in the form of a directory.

Implementations

impl Package

pub fn to_initialised( &self, initialise_options: InitialiseOptions, ) -> Result<InitialisedPackage>

Initialises this package if needed, and returns an InitialisedPackage.

impl Package

pub fn export_distributable( &self, options: ExportOptions, ) -> Result<Distributable>

Exports the package as a distributable .merlon file.

impl Package

pub fn new<N>(name: N, path: PathBuf) -> Result<Self>

where N: TryIntoName,

Create a new package at the given path. The path must not exist.

pub fn edit_manifest<F>(&self, f: F) -> Result<()>

where F: FnOnce(&mut Manifest) -> Result<()>,

Edit the package manifest. The given function will be called with a mutable reference to the manifest, and after the function returns the manifest will be written back to disk.

impl Package

pub fn current() -> Result<Option<Self>>

Gets the current package, if any, by looking for merlon.toml in the current directory and its parents.

pub fn id(&self) -> Result<Id>

The package ID.

pub fn path(&self) -> &Path

The package path.

pub fn readme(&self) -> Result<String>

Returns the text content of the README.md file in the package.

pub fn manifest(&self) -> Result<Manifest>

Returns the manifest of the package by parsing the merlon.toml file.

pub fn uuid_equals(&self, other: &Package) -> Result<bool>

Compares two packages by ID.

pub fn copyright_notice(&self) -> Result<String>

Returns a copyright notice for this package by reading the package’s LICENSE file.

impl Package

pub fn clone_to_dir(&self, path: PathBuf) -> Result<Self>

Copies the package to the given path and updates. The path must not exist. Effectively a set_path method.

Trait Implementations

impl Clone for Package

fn clone(&self) -> Package

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Package

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

Formats the value using the given formatter.

impl Display for Package

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

Formats the value using the given formatter.

impl Hash for Package

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 IntoPy<Py<PyAny>> for Package

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl PartialEq for Package

fn eq(&self, other: &Self) -> 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 PyClass for Package

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Package

const DOC: &'static str = "A package in the form of a directory.\u{0}"

Class doc string

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

type Layout = PyCell<Package>

Layout

type BaseType = PyAny

Base class

type ThreadChecker = ThreadCheckerStub<Package>

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForPackage

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a Package

type Holder = Option<PyRef<'py, Package>>

fn extract(obj: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut Package

type Holder = Option<PyRefMut<'py, Package>>

fn extract(obj: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl PyTypeInfo for Package

const NAME: &'static str = "Package"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

type AsRefTarget = PyCell<Package>

Utility type to make Py::as_ref work.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> &PyType

Returns the safe abstraction over the type object.

fn is_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type.

impl TryFrom<&Package> for Dependency

type Error = Error

The type returned in the event of a conversion error.

fn try_from(package: &Package) -> Result<Self>

Performs the conversion.

impl TryFrom<Package> for InitialisedPackage

type Error = Error

The type returned in the event of a conversion error.

fn try_from(package: Package) -> Result<Self>

Performs the conversion.

impl TryFrom<PathBuf> for Package

type Error = Error

The type returned in the event of a conversion error.

fn try_from(path: PathBuf) -> Result<Self>

Performs the conversion.

impl Eq for Package