Struct CodespacesHandler 

pub struct CodespacesHandler<'octo> { /* private fields */ }

Handler for GitHub’s Codespaces API.

Created with Octocrab::codespaces.

Implementations

impl<'octo> CodespacesHandler<'octo>

pub fn list(&self) -> ListCodespacesBuilder<'octo, '_>

Lists codespaces for the authenticated user.

See: GitHub REST API Documentation

pub async fn create(&self, body: &CreateUserCodespace) -> Result<Codespace>

Creates a codespace for the authenticated user.

See: GitHub REST API Documentation

pub async fn get(&self, codespace_name: impl AsRef<str>) -> Result<Codespace>

Gets a codespace for the authenticated user.

See: GitHub REST API Documentation

pub async fn update( &self, codespace_name: impl AsRef<str>, patch: &UpdateCodespace, ) -> Result<Codespace>

Updates a codespace for the authenticated user.

See: GitHub REST API Documentation

pub async fn delete(&self, codespace_name: impl AsRef<str>) -> Result<()>

Deletes a codespace for the authenticated user.

See: GitHub REST API Documentation

pub async fn start(&self, codespace_name: impl AsRef<str>) -> Result<Codespace>

Starts a codespace for the authenticated user.

See: GitHub REST API Documentation

pub async fn stop(&self, codespace_name: impl AsRef<str>) -> Result<Codespace>

Stops a codespace for the authenticated user.

See: GitHub REST API Documentation

pub async fn publish( &self, codespace_name: impl AsRef<str>, body: &PublishCodespace, ) -> Result<Codespace>

Creates a repository from an unpublished codespace.

See: GitHub REST API Documentation

pub async fn export( &self, codespace_name: impl AsRef<str>, ) -> Result<CodespaceExportDetails>

Triggers an export of a codespace for the authenticated user.

See: GitHub REST API Documentation

pub async fn get_export( &self, codespace_name: impl AsRef<str>, export_id: impl AsRef<str>, ) -> Result<CodespaceExportDetails>

Gets details about a codespace export.

See: GitHub REST API Documentation

pub async fn machines( &self, codespace_name: impl AsRef<str>, ) -> Result<Page<CodespaceMachine>>

Lists machine types available for a codespace.

See: GitHub REST API Documentation

pub fn secrets(&self) -> UserCodespacesSecretsHandler<'octo>

Handler for managing user-scoped Codespaces secrets.