Enum ArtifactFormat 

pub enum ArtifactFormat {
    Json,
    Yaml,
    Markdown,
    Text,
}

The encoding one generated artifact is written in.

Variants

Json

A JSON document: pretty-printed, one trailing newline, provenance as members.

Yaml

The same document in the layer’s YAML, provenance as a comment banner.

Markdown

Markdown for a reader, provenance as an HTML comment.

Text

Line-oriented text another program reads: the shell tool’s allow-lists, provenance as # comments.

Implementations

impl ArtifactFormat

pub fn suffix(self) -> &'static str

The file suffix, without the dot.

pub fn of_path(path: &str) -> ArtifactFormat

The format a path’s suffix declares, Text for anything unrecognised.

Trait Implementations

impl Clone for ArtifactFormat

fn clone(&self) -> ArtifactFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ArtifactFormat

impl Debug for ArtifactFormat

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ArtifactFormat

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ArtifactFormat

impl JsonSchema for ArtifactFormat

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for ArtifactFormat

fn cmp(&self, other: &ArtifactFormat) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ArtifactFormat

fn eq(&self, other: &ArtifactFormat) -> 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 PartialOrd for ArtifactFormat

fn partial_cmp(&self, other: &ArtifactFormat) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ArtifactFormat

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ArtifactFormat