Enum CameraState 

pub enum CameraState {
    Idle,
    Starting,
    Running {
        device: String,
    },
    Stopped,
    Failed(CameraError),
}

What the camera session is doing.

Variants

Idle

Nothing has been asked of it.

Starting

A session is opening. Phones take a noticeable moment over this, which is why it is a state a screen can show rather than a gap before frames.

Running

Frames are being produced.

Fields

device: String

The device the session opened, for a label.

Stopped

The session was stopped and the device released.

Failed(CameraError)

The session could not start, or ended on its own.

Implementations

impl CameraState

pub fn is_running(&self) -> bool

Whether frames are being produced now.

pub fn is_active(&self) -> bool

Whether the session is opening or open — which is when a screen keeps the viewfinder on screen rather than showing a placeholder.

pub fn failure(&self) -> Option<&CameraError>

The failure, if the session ended in one.

Trait Implementations

impl Clone for CameraState

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 CameraState

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

Formats the value using the given formatter.

impl Default for CameraState

fn default() -> Self

Returns the “default value” for a type.

impl Eq for CameraState

impl PartialEq for CameraState

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CameraState