Struct automaat_processor_git_clone::GitClone

pub struct GitClone {
    pub url: Url,
    pub username: Option<String>,
    pub password: Option<String>,
    pub path: Option<String>,
}

The processor configuration.

Fields

url: Url

The URL of the remote to fetch the repository from.

username: Option<String>

The optional username used to authenticate with the remote.

password: Option<String>

The optional password used to authenticate with the remote.

path: Option<String>

An optional path inside the workspace to clone the repository to. If no path is given, the root of the workspace is used. If the path does not exist, it will be created.

Trait Implementations

impl Eq for GitClone

impl PartialEq<GitClone> for GitClone

fn eq(&self, other: &GitClone) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &GitClone) -> bool

This method tests for !=.

impl Clone for GitClone

fn clone(&self) -> GitClone

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GitClone

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

Formats the value using the given formatter.

impl<'a> Processor<'a> for GitClone

const NAME: &'static str

The human-formatted name of the processor, used to visually identify this processor amongst others.

type Error = Error

If a processor fails its intended purpose, the returned error is turned into a string, and shown in the automaat-web-client application.

type Output = String

The processor can return any (successful) output it wants, as long as that type implements the [std::fmt::Display] trait.

fn validate(&self) -> Result<(), Self::Error>

Validate the GitClone configuration.

Errors

This method returns an error under the following circumstances:

• If a path option is provided that contains anything other than a simple relative path such as my/path. Anything such as ../, or /etc is not allowed. The returned error is of type Error::Path.

In a future update, this will also validate remote connectivity.

fn run(&self, context: &Context) -> Result<Option<Self::Output>, Self::Error>

Clone the repository as defined by the provided configuration.

The repository will be cloned in the automaat_core::Context workspace, optionally in a child path.

Output

None is returned if the processor runs successfully.

Errors

Any errors during cloning will return an Error::Git result value.

impl<'de> Deserialize<'de> for GitClone

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for GitClone

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.