Enum github_types::Preview

pub enum Preview {
    Wyandotte,
    BarredRock,
    AntMan,
    SquirrelGirl,
    Mockingbird,
    MisterFantastic,
    MachineMan,
    Inertia,
    Cloak,
    BlackPanther,
    GiantSentryFist,
    Mercy,
    ScarletWitch,
    Hellcat,
    Nightshade,
    SailorV,
    Dazzler,
    Echo,
    Symmetra,
    Zzzax,
    LukeCage,
    Hagar,
    Antiope,
    Starfox,
    Fury,
    Flash,
    Surtur,
    Corsair,
    Sombra,
    ShadowCat,
    Switcheroo,
    Groot,
    Gambit,
}

API previews.

See: https://developer.github.com/v3/previews/

Variants

Wyandotte

Allows you to download repositories from your GitHub user or organization account to review, backup, and migrate data to GitHub Enterprise Server.

BarredRock

Import source repositories to GitHub with the API version of the GitHub Importer.

AntMan

Exercise greater control over deployments with more information and finer granularity.

SquirrelGirl

Manage reactions for commits, issues, and comments.

Mockingbird

Get a list of events for an issue or pull request.

MisterFantastic

Get more information about your GitHub Pages site.

MachineMan

Manage integrations through the API.

Inertia

Manage projects.

Cloak

Search commits.

BlackPanther

Retrieve community profile metrics (also known as community health) for any public repository.

GiantSentryFist

Users can block other users. Organizations can block users, too.

Mercy

View a list of repository topics in calls that return repository results.

ScarletWitch

View all codes of conduct or get which code of conduct a repository has currently.

Hellcat

Include nested team content in team payloads.

Nightshade

Transfer a repository to an organization or user.

SailorV

You can now add a reason when you lock an issue.

Dazzler

You can now use the API to invite new users to an organization by creating an organization invitation.

Echo

You can now use the API to manage team discussions and team discussion comments.

Symmetra

You can now use emoji in label names, add descriptions to labels, and search for labels in a repository.

Zzzax

You can now use the API to manage the setting for requiring signed commits on protected branches.

LukeCage

You can now require multiple approving reviews for a pull request using the API.

Hagar

Retrieve information from someone's hovercard.

Antiope

Allows a GitHub App to run external checks on a repository's code. See the Check runs and Check suites APIs for more details.

Starfox

The REST API v3 responses for issue events and issue timeline events now return the project_card field for project-related events.

Fury

GitHub App Manifests allow people to create preconfigured GitHub Apps. See "Creating GitHub Apps from a manifest" for more details.

Flash

You can now update the environment of a deployment status and use the in_progress and queued states. When you create deployment statuses, you can now use the auto_inactive parameter to mark old production deployments as inactive.

Surtur

You can now configure whether organization members can create repositories and which types of repositories they can create. See "Edit an organization" for more details.

Corsair

You can now provide more information in GitHub for URLs that link to registered domains by using the Content Attachments API. See "Using content attachments" for more details.

Sombra

Allows you to temporarily restrict interactions, such as commenting, opening issues, and creating pull requests, for GitHub repositories or organizations. When enabled, only the specified group of GitHub users will be able to participate in these interactions. See the Repository interactions and Organization interactions APIs for more details.

ShadowCat

You can use the Draft Pull Requests API and its pull request endpoints to see whether a pull request is in draft state. To learn more about draft pull requests, see "About pull requests" in the GitHub Help documentation.

Switcheroo

You can use the new endpoints in the Pages API to enable or disable Pages. To learn more about Pages, see "GitHub Pages Basics" in the GitHub Help documentation.

Groot

You can use the new endpoints in the Commits API to list branches or pull requests for a commit.

Gambit

Owners of GitHub Apps can now uninstall an app using the Apps API.

Methods

impl Preview

pub fn name(self) -> &'static str

Returns the kebab-case name of the preview.

pub fn media_type(self) -> String

Returns the media type for the preview. This can be used for the Accept header in requests.

Trait Implementations

impl PartialOrd<Preview> for Preview

fn partial_cmp(&self, other: &Preview) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Ord for Preview

fn cmp(&self, other: &Preview) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Eq for Preview

impl Copy for Preview

impl Clone for Preview

fn clone(&self) -> Preview

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<Preview> for Preview

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl Hash for Preview

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Display for Preview

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

Formats the value using the given formatter.

impl Debug for Preview

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

Formats the value using the given formatter.