Enum TelevisionChannel

pub enum TelevisionChannel {
    Env(Channel),
    Files(Channel),
    GitRepos(Channel),
    Dirs(Channel),
    Text(Channel),
    Stdin(Channel),
    Alias(Channel),
    RemoteControl(RemoteControl),
    Cable(Channel),
}

The available television channels.

Each channel is represented by a variant of the enum and should implement the OnAir trait.

Important

When adding a new channel, make sure to add a new variant to this enum and implement the OnAir trait for it.

Derive

CliChannel

The CliChannel derive macro generates the necessary glue code to automatically create the corresponding CliTvChannel enum with unit variants that can be used to select the channel from the command line. It also generates the necessary glue code to automatically create a channel instance from the selected CLI enum variant.

Broadcast

The Broadcast derive macro generates the necessary glue code to automatically forward method calls to the corresponding channel variant. This allows to use the OnAir trait methods directly on the TelevisionChannel enum. In a more straightforward way, it implements the OnAir trait for the TelevisionChannel enum.

UnitChannel

This macro generates an enum with unit variants that can be used instead of carrying the actual channel instances around. It also generates the necessary glue code to automatically create a channel instance from the selected enum variant.

Variants

Env(Channel)

The environment variables channel.

This channel allows to search through environment variables.

Files(Channel)

The files channel.

This channel allows to search through files.

GitRepos(Channel)

The git repositories channel.

This channel allows to search through git repositories.

Dirs(Channel)

The dirs channel.

This channel allows to search through directories.

Text(Channel)

The text channel.

This channel allows to search through the contents of text files.

Stdin(Channel)

The standard input channel.

This channel allows to search through whatever is passed through stdin.

Alias(Channel)

The alias channel.

This channel allows to search through aliases.

RemoteControl(RemoteControl)

The remote control channel.

This channel allows to switch between different channels.

Cable(Channel)

A custom channel.

This channel allows to search through custom data.

Implementations

impl TelevisionChannel

pub fn zap(&self, channel_name: &str) -> Result<TelevisionChannel>

impl TelevisionChannel

pub fn available_transitions(&self) -> Vec<UnitChannel>

pub fn transition_to(&mut self, target: UnitChannel) -> TelevisionChannel

Trait Implementations

impl From<&Entry> for TelevisionChannel

fn from(entry: &Entry) -> Self

Converts to this type from the input type.

impl From<&TelevisionChannel> for UnitChannel

fn from(channel: &TelevisionChannel) -> Self

Converts to this type from the input type.

impl Into<TelevisionChannel> for UnitChannel

fn into(self) -> TelevisionChannel

Converts this type into the (usually inferred) input type.

impl OnAir for TelevisionChannel

fn find(&mut self, pattern: &str)

Find entries that match the given pattern.

fn results(&mut self, num_entries: u32, offset: u32) -> Vec<Entry>

Get the results of the search (that are currently available).

fn get_result(&self, index: u32) -> Option<Entry>

Get a specific result by its index.

fn selected_entries(&self) -> &FxHashSet<Entry>

Get the currently selected entries.

fn toggle_selection(&mut self, entry: &Entry)

Toggles selection for the entry under the cursor.

fn result_count(&self) -> u32

Get the number of results currently available.

fn total_count(&self) -> u32

Get the total number of entries currently available.

fn running(&self) -> bool

Check if the channel is currently running.

fn shutdown(&self)

Turn off