Struct WriteNoteRequest 

#[non_exhaustive]
pub struct WriteNoteRequest {
    pub vault: String,
    pub path: String,
    pub content: String,
    pub precondition: WritePrecondition,
    pub commit_message: Option<String>,
    pub provenance: Option<WriteProvenance>,
}

Safe full-note write request.

Construct with Self::new; the optional fields have builder setters. The type is #[non_exhaustive] so the contract can gain fields without breaking plugins that build requests through the constructor.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

vault: String

Vault to write to.

Required, and checked by the host. TurboVault serves one active vault at a time and that selection can change between a plugin’s read and its write; naming the vault turns that race into a refusal instead of a write landing in the wrong vault.

path: String

Vault-relative note path.

content: String

Complete replacement content.

precondition: WritePrecondition

Mandatory create-or-CAS condition; blind overwrites are not exposed.

commit_message: Option<String>

Optional Git commit subject. Hosts may require it by policy.

provenance: Option<WriteProvenance>

Optional best-effort writer identity for hook correlation.

This metadata is advisory and is not an authorization boundary. The host separately stamps the calling plugin’s namespace onto the event it publishes, and that stamp is the trustworthy one.

Implementations

impl WriteNoteRequest

pub fn new( vault: impl Into<String>, path: impl Into<String>, content: impl Into<String>, precondition: WritePrecondition, ) -> Self

Construct a write request for vault.

pub fn with_commit_message(self, message: impl Into<String>) -> Self

Set the Git commit subject.

pub fn with_provenance(self, provenance: WriteProvenance) -> Self

Set advisory writer provenance.

Trait Implementations

impl Clone for WriteNoteRequest

fn clone(&self) -> WriteNoteRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WriteNoteRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WriteNoteRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for WriteNoteRequest

impl PartialEq for WriteNoteRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for WriteNoteRequest

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 WriteNoteRequest