Struct ControlDirFormat 

pub struct ControlDirFormat(/* private fields */);

The format of a control directory.

This struct represents the format of a control directory, which defines how the control directory is stored on disk and what capabilities it has.

Implementations

impl ControlDirFormat

pub fn get_format_string(&self) -> Vec<u8>

Get the format string for this control directory format.

Returns

The format string as a byte vector.

pub fn get_format_description(&self) -> String

Get a human-readable description of this control directory format.

Returns

A string describing this control directory format.

pub fn is_control_filename(&self, filename: &str) -> bool

Check if a filename is a control filename in this format.

Parameters

• filename - The filename to check.

Returns

true if the filename is a control filename, false otherwise.

pub fn initialize_on_transport( &self, transport: &Transport, ) -> Result<Box<dyn ControlDir<Branch = GenericBranch, Repository = GenericRepository, WorkingTree = GenericWorkingTree>>, Error>

Initialize a control directory of this format on a transport.

Parameters

• transport - The transport to initialize the control directory on.

Returns

The initialized control directory, or an error if initialization failed.

pub fn initialize( &self, location: impl AsLocation, ) -> Result<Box<dyn ControlDir<Branch = GenericBranch, Repository = GenericRepository, WorkingTree = GenericWorkingTree>>, Error>

Initialize a control directory of this format at a location.

Parameters

• location - The location to initialize the control directory at.

Returns

The initialized control directory, or an error if initialization failed.

Trait Implementations

impl AsFormat for &ControlDirFormat

fn as_format(&self) -> Option<ControlDirFormat>

Convert to a control directory format.

impl Clone for ControlDirFormat

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ControlDirFormat

fn default() -> Self

Returns the “default value” for a type.

impl From<Py<PyAny>> for ControlDirFormat

fn from(obj: Py<PyAny>) -> Self

Converts to this type from the input type.

impl<'py> IntoPyObject<'py> for ControlDirFormat

type Target = PyAny

The Python output type

type Output = Bound<'py, <ControlDirFormat as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = Infallible

The type returned in the event of a conversion error.

fn into_pyobject(self, py: Python<'py>) -> Result<Self::Output, Self::Error>

Performs the conversion.