Struct BeginSynchronizedUpdate

pub struct BeginSynchronizedUpdate;

Available on crate features dep_crossterm and std only.

A command that instructs the terminal emulator to begin a synchronized frame.

Notes

• Commands must be executed/queued for execution otherwise they do nothing.
• Use EndSynchronizedUpdate command to leave the entered alternate screen.

When rendering the screen of the terminal, the Emulator usually iterates through each visible grid cell and renders its current state. With applications updating the screen at a higher frequency this can cause tearing.

This mode attempts to mitigate that.

When the synchronization mode is enabled following render calls will keep rendering the last rendered state. The terminal Emulator keeps processing incoming text and sequences. When the synchronized update mode is disabled again the renderer may fetch the latest screen buffer state again, effectively avoiding the tearing effect by unintentionally rendering in the middle a of an application screen update.

Examples

use std::io::{self, Write};
use crossterm::{execute, terminal::{BeginSynchronizedUpdate, EndSynchronizedUpdate}};

fn main() -> io::Result<()> {
    execute!(io::stdout(), BeginSynchronizedUpdate)?;

    // Anything performed here will not be rendered until EndSynchronizedUpdate is called.

    execute!(io::stdout(), EndSynchronizedUpdate)?;
    Ok(())
}

Trait Implementations

impl Clone for BeginSynchronizedUpdate

fn clone(&self) -> BeginSynchronizedUpdate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Command for BeginSynchronizedUpdate

fn write_ansi(&self, f: &mut impl Write) -> Result<(), Error>

Write an ANSI representation of this command to the given writer. An ANSI code can manipulate the terminal by writing it to the terminal buffer. However, only Windows 10 and UNIX systems support this.

impl Debug for BeginSynchronizedUpdate

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

Formats the value using the given formatter.

impl PartialEq for BeginSynchronizedUpdate

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for BeginSynchronizedUpdate

impl Eq for BeginSynchronizedUpdate

impl StructuralPartialEq for BeginSynchronizedUpdate