Skip to main content

EditMode

Enum EditMode 

Source
pub enum EditMode {
    Overwrite,
    Append,
    Prepend,
}
Expand description

Behavior mode for NbClient::edit_note content updates.

§Vocabulary

The variant previously named Replace is now Overwrite to remove the vocabulary trap at the root of nb-api:issues/api/6: callers reading mode: "replace" reasonably expected a substring-style replacement (analogous to str::replace), but nb edit --overwrite is destructive — it replaces every byte of the note body. Renaming the variant to Overwrite makes the destructive intent unambiguous at the call site.

The legacy string "replace" is accepted as a serde alias for backward compatibility with payloads produced before this rename. The alias is not advertised in the derived schemars JSON Schema — only the canonical "overwrite" is exposed to MCP tool consumers.

§Mapping

VariantCanonical serializationnb edit flag(s)Effect
EditMode::Overwrite"overwrite"--overwrite --content <content>Replace every byte of the note body with <content>. Destructive: any existing content is lost.
EditMode::Append"append"--content <content>Append <content> after the existing note body.
EditMode::Prepend"prepend"--prepend --content <content>Prepend <content> before the existing note body.

§Default

EditMode derives Default with EditMode::Overwrite as the default variant. This is the nb-api default, chosen for compatibility with the current API contract and the documented destructive default on nb_api’s edit API. Note that this is distinct from the nb CLI’s native no-flag behavior (nb edit --content without --overwrite appends; see the mapping table above). Requiredness on the consumer side (e.g., the mode field on nb-mcp-server’s EditArgs) is a consumer-layer concern, not enforced here. Downstream consumers that want to require mode explicitly should drop #[serde(default)] from their containing struct.

Variants§

§

Overwrite

Replace every byte of the note body with the provided content. Destructive: any existing content is lost. Maps to nb edit --overwrite --content <content>.

Accepts legacy "replace" as a serde alias for backward compatibility with payloads produced before the variant rename. The alias is not advertised in the derived JSON Schema; only "overwrite" is exposed to schema consumers.

§

Append

Append the provided content after the existing note body. Maps to nb edit --content <content> (the nb default content-mode behavior).

§

Prepend

Prepend the provided content before the existing note body. Maps to nb edit --prepend --content <content>.

Trait Implementations§

Source§

impl Clone for EditMode

Source§

fn clone(&self) -> EditMode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for EditMode

Source§

impl Debug for EditMode

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for EditMode

Source§

fn default() -> EditMode

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for EditMode

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for EditMode

Source§

impl PartialEq for EditMode

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for EditMode

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for EditMode

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more