Struct zng_view_api::ViewConfig

pub struct ViewConfig {
    pub version: Txt,
    pub server_name: Txt,
    pub headless: bool,
}

Configuration for starting a view-process.

Fields

version: Txt

The VERSION of the API crate in the app-process.

server_name: Txt

Name of the initial channel used in connect_view_process to setup the connections to the client app-process.

headless: bool

If the server should consider all window requests, headless window requests.

Implementations

impl ViewConfig

pub fn from_env() -> Option<Self>

Reads config from environment variables set by the Controller in a view-process instance.

View API implementers should call this to get the config when it suspects that is running as a view-process. Returns Some(_) if the process was initialized as a view-process.

pub fn wait_same_process() -> Self

Wait for config from same-process.

View API implementers should call this to sign that view-process config should be send to the same process and then start the “app-process” code path in a different thread. This function returns when the app code path sends the “view-process” configuration.

pub fn assert_version(&self, is_same_process: bool)

Assert that the VERSION is the same in the app-process and view-process.

This method must be called in the view-process implementation, it fails if the versions don’t match, panics if is_same_process or writes to stderr and exits with code .

pub fn is_version_err(exit_code: Option<i32>, stderr: Option<&str>) -> bool

Returns true if a view-process exited because of assert_version.

Trait Implementations

impl Clone for ViewConfig

fn clone(&self) -> ViewConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ViewConfig

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

Formats the value using the given formatter.