Struct UiScrollMessage 

pub struct UiScrollMessage {
    pub client_id: String,
    pub component: UiSiteComponent,
    pub instance_id: String,
    pub offset: u64,
    pub follow_end: Option<bool>,
    pub uuid: String,
    pub session_id: String,
}

system/ui_scroll — a plugin’s $.ui.scroll moved the window of a site a remote surface draws: the surface scrolls the site’s body there. The person’s own scrolls are never pushed back (CLI 2.1.285+).

Fields

client_id: String

The client drawing the site, as it attached.

component: UiSiteComponent

Which site: a pane’s body or the band above the prompt.

instance_id: String

The pane’s id, or above-prompt for the band.

offset: u64

The first content row the window is to show, 0 at the top, clamped to the tree as the surface last reported it.

follow_end: Option<bool>

true: keep the window on the tree’s last rows through the draws to come, until the person or a plugin next moves it.

uuid: String

session_id: String

Trait Implementations

impl Clone for UiScrollMessage

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UiScrollMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UiScrollMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for UiScrollMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.