Struct roctogen::endpoints::gists::Gists

pub struct Gists<'api> { /* fields omitted */ }

Implementations

impl<'api> Gists<'api>

pub async fn check_is_starred_async(
    &self,
    gist_id: &str
) -> Result<(), GistsCheckIsStarredError>

---

Check if a gist is starred

GitHub API docs for check_is_starred

---

pub fn check_is_starred(
    &self,
    gist_id: &str
) -> Result<(), GistsCheckIsStarredError>

---

Check if a gist is starred

GitHub API docs for check_is_starred

---

pub async fn create_async(
    &self,
    body: PostGistsCreate
) -> Result<GistSimple, GistsCreateError>

---

Create a gist

Allows you to add a new gist with one or more files.

Note: Don’t name your files “gistfile” with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.

GitHub API docs for create

---

pub fn create(
    &self,
    body: PostGistsCreate
) -> Result<GistSimple, GistsCreateError>

---

Create a gist

Allows you to add a new gist with one or more files.

Note: Don’t name your files “gistfile” with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.

GitHub API docs for create

---

pub async fn create_comment_async(
    &self,
    gist_id: &str,
    body: PostGistsCreateComment
) -> Result<GistComment, GistsCreateCommentError>

---

Create a gist comment

GitHub API docs for create_comment

---

pub fn create_comment(
    &self,
    gist_id: &str,
    body: PostGistsCreateComment
) -> Result<GistComment, GistsCreateCommentError>

---

Create a gist comment

GitHub API docs for create_comment

---

pub async fn delete_async(&self, gist_id: &str) -> Result<(), GistsDeleteError>

---

Delete a gist

GitHub API docs for delete

---

pub fn delete(&self, gist_id: &str) -> Result<(), GistsDeleteError>

---

Delete a gist

GitHub API docs for delete

---

pub async fn delete_comment_async(
    &self,
    gist_id: &str,
    comment_id: i32
) -> Result<(), GistsDeleteCommentError>

---

Delete a gist comment

GitHub API docs for delete_comment

---

pub fn delete_comment(
    &self,
    gist_id: &str,
    comment_id: i32
) -> Result<(), GistsDeleteCommentError>

---

Delete a gist comment

GitHub API docs for delete_comment

---

pub async fn fork_async(
    &self,
    gist_id: &str
) -> Result<BaseGist, GistsForkError>

---

Fork a gist

Note: This was previously /gists/:gist_id/fork.

GitHub API docs for fork

---

pub fn fork(&self, gist_id: &str) -> Result<BaseGist, GistsForkError>

---

Fork a gist

Note: This was previously /gists/:gist_id/fork.

GitHub API docs for fork

---

pub async fn get_async(
    &self,
    gist_id: &str
) -> Result<GistSimple, GistsGetError>

---

Get a gist

GitHub API docs for get

---

pub fn get(&self, gist_id: &str) -> Result<GistSimple, GistsGetError>

---

Get a gist

GitHub API docs for get

---

pub async fn get_comment_async(
    &self,
    gist_id: &str,
    comment_id: i32
) -> Result<GistComment, GistsGetCommentError>

---

Get a gist comment

GitHub API docs for get_comment

---

pub fn get_comment(
    &self,
    gist_id: &str,
    comment_id: i32
) -> Result<GistComment, GistsGetCommentError>

---

Get a gist comment

GitHub API docs for get_comment

---

pub async fn get_revision_async(
    &self,
    gist_id: &str,
    sha: &str
) -> Result<GistSimple, GistsGetRevisionError>

---

Get a gist revision

GitHub API docs for get_revision

---

pub fn get_revision(
    &self,
    gist_id: &str,
    sha: &str
) -> Result<GistSimple, GistsGetRevisionError>

---

Get a gist revision

GitHub API docs for get_revision

---

pub async fn list_async(
    &self,
    query_params: Option<impl Into<GistsListParams>>
) -> Result<Vec<BaseGist>, GistsListError>

---

List gists for the authenticated user

Lists the authenticated user’s gists or if called anonymously, this endpoint returns all public gists:

GitHub API docs for list

---

pub fn list(
    &self,
    query_params: Option<impl Into<GistsListParams>>
) -> Result<Vec<BaseGist>, GistsListError>

---

List gists for the authenticated user

Lists the authenticated user’s gists or if called anonymously, this endpoint returns all public gists:

GitHub API docs for list

---

pub async fn list_comments_async(
    &self,
    gist_id: &str,
    query_params: Option<impl Into<GistsListCommentsParams>>
) -> Result<Vec<GistComment>, GistsListCommentsError>

---

List gist comments

GitHub API docs for list_comments

---

pub fn list_comments(
    &self,
    gist_id: &str,
    query_params: Option<impl Into<GistsListCommentsParams>>
) -> Result<Vec<GistComment>, GistsListCommentsError>

---

List gist comments

GitHub API docs for list_comments

---

pub async fn list_commits_async(
    &self,
    gist_id: &str,
    query_params: Option<impl Into<GistsListCommitsParams>>
) -> Result<Vec<GistCommit>, GistsListCommitsError>

---

List gist commits

GitHub API docs for list_commits

---

pub fn list_commits(
    &self,
    gist_id: &str,
    query_params: Option<impl Into<GistsListCommitsParams>>
) -> Result<Vec<GistCommit>, GistsListCommitsError>

---

List gist commits

GitHub API docs for list_commits

---

pub async fn list_for_user_async(
    &self,
    username: &str,
    query_params: Option<impl Into<GistsListForUserParams>>
) -> Result<Vec<BaseGist>, GistsListForUserError>

---

List gists for a user

Lists public gists for the specified user:

GitHub API docs for list_for_user

---

pub fn list_for_user(
    &self,
    username: &str,
    query_params: Option<impl Into<GistsListForUserParams>>
) -> Result<Vec<BaseGist>, GistsListForUserError>

---

List gists for a user

Lists public gists for the specified user:

GitHub API docs for list_for_user

---

pub async fn list_forks_async(
    &self,
    gist_id: &str,
    query_params: Option<impl Into<GistsListForksParams>>
) -> Result<Vec<GistSimple>, GistsListForksError>

---

List gist forks

GitHub API docs for list_forks

---

pub fn list_forks(
    &self,
    gist_id: &str,
    query_params: Option<impl Into<GistsListForksParams>>
) -> Result<Vec<GistSimple>, GistsListForksError>

---

List gist forks

GitHub API docs for list_forks

---

pub async fn list_public_async(
    &self,
    query_params: Option<impl Into<GistsListPublicParams>>
) -> Result<Vec<BaseGist>, GistsListPublicError>

---

List public gists

List public gists sorted by most recently updated to least recently updated.

Note: With pagination, you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.

GitHub API docs for list_public

---

pub fn list_public(
    &self,
    query_params: Option<impl Into<GistsListPublicParams>>
) -> Result<Vec<BaseGist>, GistsListPublicError>

---

List public gists

List public gists sorted by most recently updated to least recently updated.

Note: With pagination, you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.

GitHub API docs for list_public

---

pub async fn list_starred_async(
    &self,
    query_params: Option<impl Into<GistsListStarredParams>>
) -> Result<Vec<BaseGist>, GistsListStarredError>

---

List starred gists

List the authenticated user’s starred gists:

GitHub API docs for list_starred

---

pub fn list_starred(
    &self,
    query_params: Option<impl Into<GistsListStarredParams>>
) -> Result<Vec<BaseGist>, GistsListStarredError>

---

List starred gists

List the authenticated user’s starred gists:

GitHub API docs for list_starred

---

pub async fn star_async(&self, gist_id: &str) -> Result<(), GistsStarError>

---

Star a gist

Note that you’ll need to set Content-Length to zero when calling out to this endpoint. For more information, see “HTTP verbs.”

GitHub API docs for star

---

pub fn star(&self, gist_id: &str) -> Result<(), GistsStarError>

---

Star a gist

Note that you’ll need to set Content-Length to zero when calling out to this endpoint. For more information, see “HTTP verbs.”

GitHub API docs for star

---

pub async fn unstar_async(&self, gist_id: &str) -> Result<(), GistsUnstarError>

---

Unstar a gist

GitHub API docs for unstar

---

pub fn unstar(&self, gist_id: &str) -> Result<(), GistsUnstarError>

---

Unstar a gist

GitHub API docs for unstar

---

pub async fn update_async(
    &self,
    gist_id: &str,
    body: PatchGistsUpdate
) -> Result<GistSimple, GistsUpdateError>

---

Update a gist

Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren’t explicitly changed during an edit are unchanged.

GitHub API docs for update

---

pub fn update(
    &self,
    gist_id: &str,
    body: PatchGistsUpdate
) -> Result<GistSimple, GistsUpdateError>

---

Update a gist

Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren’t explicitly changed during an edit are unchanged.

GitHub API docs for update

---

pub async fn update_comment_async(
    &self,
    gist_id: &str,
    comment_id: i32,
    body: PatchGistsUpdateComment
) -> Result<GistComment, GistsUpdateCommentError>

---

Update a gist comment

GitHub API docs for update_comment

---

pub fn update_comment(
    &self,
    gist_id: &str,
    comment_id: i32,
    body: PatchGistsUpdateComment
) -> Result<GistComment, GistsUpdateCommentError>

---

Update a gist comment

GitHub API docs for update_comment

---