Struct SourceRef 

pub struct SourceRef {
    pub kind: SourceKind,
    pub uri: Option<String>,
    pub title: Option<String>,
    pub captured_at: Option<String>,
    pub source_local_id: Option<String>,
}

Portable reference to source material.

Fields

kind: SourceKind

Source category.

uri: Option<String>

Optional stable URI for source material.

title: Option<String>

Optional human-readable source title.

captured_at: Option<String>

Optional stable text capture time, such as RFC 3339.

source_local_id: Option<String>

Optional identifier meaningful within the source system.

Implementations

impl SourceRef

pub fn new(kind: SourceKind) -> Self

Creates a source reference with no optional metadata.

pub fn with_uri(self, uri: impl Into<String>) -> Result<Self>

Returns this source reference with a validated URI.

pub fn with_title(self, title: impl Into<String>) -> Result<Self>

Returns this source reference with a validated title.

pub fn with_captured_at(self, captured_at: impl Into<String>) -> Result<Self>

Returns this source reference with a validated capture timestamp payload.

pub fn with_source_local_id( self, source_local_id: impl Into<String>, ) -> Result<Self>

Returns this source reference with a validated source-local identifier.

pub fn validate(&self) -> Result<()>

Validates custom source kind and optional payload fields.

Trait Implementations

impl Clone for SourceRef

fn clone(&self) -> SourceRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SourceRef

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SourceRef

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SourceRef

impl StructuralPartialEq for SourceRef