Struct Github

pub struct Github { /* private fields */ }

Displays the number of github notifications you have.

Trait Implementations

impl Clone for Github

fn clone(&self) -> Github

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Github

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

Formats the value using the given formatter.

impl PanelConfig for Github

fn parse( name: &'static str, table: &mut HashMap<String, Value>, _global: &Config, ) -> Result<Self>

Parses an instance of the panel from the global [Config]

Configuration options:

• interval: how long to wait between requests. The panel will never poll more often than this, but it may poll less often according to the X-Poll-Interval header of the reponse. See https://docs.github.com/en/rest/activity/notifications?apiVersion=2022-11-28#about-github-notifications for more information.
• token: A file path containing your GitHub token. Visit https://github.com/settings/tokens/new to generate a token. The notifications scope is required.
• filter: An array of strings corresponding to notification reasons. See https://docs.github.com/en/rest/activity/notifications?apiVersion=2022-11-28#about-notification-reasons for details.
• include: Whether to include or exclude the reasons in filter. If include is true, only notifications with one of the reasons in filter will be counted. Otherwise, only notifications with reasons not in filter will be counted.
• show_zero: Whether or not the panel is shown when you have zero notifications.
• format: The formatting option. The only formatting option is %count%.
• attrs: A string specifying the attrs for the panel. See Attrs::parse for details.
• highlight: A string specifying the highlight for the panel. See Highlight::parse for details.
• See PanelCommon::parse_common.

fn props(&self) -> (&'static str, bool)

Returns the name of the panel. If the panel supports events, each instance must return a unique name.

fn run<'async_trait>( self: Box<Self>, cr: Rc<Context>, global_attrs: Attrs, height: i32, ) -> Pin<Box<dyn Future<Output = Result<(PanelStream, Option<ChannelEndpoint<Event, EventResponse>>)>> + 'async_trait>>

where Self: 'async_trait,

Performs any necessary setup, then returns a PanelStream representing the provided PanelConfig.