Struct EditOptions 

pub struct EditOptions {
    pub item_id: String,
    pub name: Option<String>,
    pub description: Option<String>,
    pub refines: Option<Vec<String>>,
    pub derives_from: Option<Vec<String>>,
    pub satisfies: Option<Vec<String>>,
    pub specification: Option<String>,
    pub platform: Option<String>,
}

Options for editing an item.

Fields

item_id: String

The item ID to edit.

name: Option<String>

New name (if provided).

description: Option<String>

New description (if provided).

refines: Option<Vec<String>>

New refines references (if provided).

derives_from: Option<Vec<String>>

New derives_from references (if provided).

satisfies: Option<Vec<String>>

New satisfies references (if provided).

specification: Option<String>

New specification (if provided).

platform: Option<String>

New platform (if provided).

Implementations

impl EditOptions

pub fn new(item_id: impl Into<String>) -> Self

Creates new edit options for the given item ID.

pub fn with_name(self, name: impl Into<String>) -> Self

Sets the name.

pub fn with_description(self, description: impl Into<String>) -> Self

Sets the description.

pub fn with_refines(self, refines: Vec<String>) -> Self

Sets the refines references.

pub fn with_derives_from(self, derives_from: Vec<String>) -> Self

Sets the derives_from references.

pub fn with_satisfies(self, satisfies: Vec<String>) -> Self

Sets the satisfies references.

pub fn with_specification(self, specification: impl Into<String>) -> Self

Sets the specification.

pub fn with_platform(self, platform: impl Into<String>) -> Self

Sets the platform.

pub fn has_updates(&self) -> bool

Returns true if any modification was requested.

Trait Implementations

impl Clone for EditOptions

fn clone(&self) -> EditOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EditOptions

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

Formats the value using the given formatter.

impl Default for EditOptions

fn default() -> EditOptions

Returns the “default value” for a type.