Struct PublishingResult 

pub struct PublishingResult {
    pub success: bool,
    pub commit_hash: Option<String>,
    pub files_published: Vec<String>,
    pub error: Option<String>,
}

Documentation publishing result

Fields

success: bool

Publishing successful

commit_hash: Option<String>

Commit hash

files_published: Vec<String>

Files published

error: Option<String>

Error message if failed

Implementations

impl PublishingResult

pub fn success(commit_hash: impl Into<String>) -> Self

Create a successful publishing result

pub fn failure(error: impl Into<String>) -> Self

Create a failed publishing result

pub fn with_file(self, file: impl Into<String>) -> Self

Add a published file

Trait Implementations

impl Clone for PublishingResult

fn clone(&self) -> PublishingResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PublishingResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PublishingResult

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PublishingResult

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

where __S: Serializer,

Serialize this value into the given Serde serializer.