Struct PluginUpdate

pub struct PluginUpdate {
    pub view_id: ViewId,
    pub delta: Option<RopeDelta>,
    pub new_len: usize,
    pub new_line_count: usize,
    pub rev: u64,
    pub undo_group: Option<usize>,
    pub edit_type: String,
    pub author: String,
}

A simple update, sent to a plugin.

Fields

view_id: ViewId

delta: Option<RopeDelta>

The delta representing changes to the document.

Note: Is Some in the general case; only if the delta involves inserting more than some maximum number of bytes, will this be None, indicating the plugin should flush cache and fetch manually.

new_len: usize

The size of the document after applying this delta.

new_line_count: usize

The total number of lines in the document after applying this delta.

rev: u64

undo_group: Option<usize>

The undo_group associated with this update. The plugin may pass this value back to core when making an edit, to associate the plugin’s edit with this undo group. Core uses undo_group

edit_type: String

author: String

Implementations

impl PluginUpdate

pub fn new<D>( view_id: ViewId, rev: u64, delta: D, new_len: usize, new_line_count: usize, undo_group: Option<usize>, edit_type: String, author: String, ) -> Self

where D: Into<Option<RopeDelta>>,

Trait Implementations

impl Clone for PluginUpdate

fn clone(&self) -> PluginUpdate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PluginUpdate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PluginUpdate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PluginUpdate

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

where __S: Serializer,

Serialize this value into the given Serde serializer.