Struct OtaClient

Source

pub struct OtaClient {
    client: Client,
    token: Option<SecretString>,
}

Expand description

HTTP client for downloading OTA updates from GitHub.

This client handles the complete OTA update workflow:

Fetching PR information from GitHub API
Finding associated workflow runs
Downloading build artifacts and stable releases
Extracting and deploying updates

§Security

The GitHub personal access token is optional and wrapped in SecretString from the secrecy crate to prevent accidental exposure in logs, debug output, or error messages. The token is automatically wiped from memory when dropped. Access to the token value requires explicit use of .expose_secret().

Token is required for:

PR build downloads
Default branch artifact downloads

Token is optional for:

Stable release downloads (public URLs)

Fields§

§client: Client§token: Option<SecretString>

Struct OtaClient Copy item path

§Security

Fields§

Implementations§

impl OtaClient

pub fn new(github_token: Option<SecretString>) -> Result<Self, OtaError>

§Arguments

§Errors

§Security

fn get_token(&self) -> Result<&SecretString, OtaError>

§Errors

pub fn download_pr_artifact<F>( &self, pr_number: u32, progress_callback: F, ) -> Result<PathBuf, OtaError>where F: FnMut(OtaProgress),

§Arguments

§Returns

§Errors

pub fn download_default_branch_artifact<F>( &self, progress_callback: F, ) -> Result<PathBuf, OtaError>where F: FnMut(OtaProgress),

§Arguments

§Returns

§Errors

pub fn download_stable_release_artifact<F>( &self, progress_callback: F, ) -> Result<PathBuf, OtaError>where F: FnMut(OtaProgress),

§Arguments

§Returns

§Errors

pub fn deploy(&self, kobo_root_path: PathBuf) -> Result<PathBuf, OtaError>

§Arguments

§Returns

§Errors

fn deploy_bytes(&self, data: &[u8]) -> Result<PathBuf, OtaError>

§Arguments

§Returns

§Errors

pub fn extract_and_deploy(&self, zip_path: PathBuf) -> Result<PathBuf, OtaError>

§Arguments

§Returns

§Errors

fn fetch_default_branch(&self) -> Result<String, OtaError>

fn find_artifact_in_run( &self, run_id: u64, name_prefix: &str, ) -> Result<Artifact, OtaError>

fn download_by_url_to_path<F>( &self, url: &str, total_size: u64, download_path: &PathBuf, progress_callback: &mut F, use_auth: bool, ) -> Result<(), OtaError>where F: FnMut(OtaProgress),

§Arguments

§Returns

fn download_artifact_to_path<F>( &self, artifact: &Artifact, download_path: &PathBuf, progress_callback: &mut F, ) -> Result<(), OtaError>where F: FnMut(OtaProgress),

fn download_chunk_with_retries( &self, url: &str, start: u64, end: u64, use_auth: bool, ) -> Result<Vec<u8>, OtaError>

§Arguments

§Returns

§Errors

fn download_chunk( &self, url: &str, start: u64, end: u64, use_auth: bool, ) -> Result<Vec<u8>, OtaError>

§Arguments

§Returns

§Errors

fn download_release_asset<F>( &self, asset: &ReleaseAsset, download_path: &PathBuf, progress_callback: &mut F, ) -> Result<(), OtaError>where F: FnMut(OtaProgress),

Auto Trait Implementations§

impl Freeze for OtaClient

impl !RefUnwindSafe for OtaClient

impl Send for OtaClient

impl Sync for OtaClient

impl Unpin for OtaClient

impl !UnwindSafe for OtaClient

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Downcast for Twhere T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> DowncastSend for Twhere T: Any + Send,

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

impl<T> DowncastSync for Twhere T: Any + Send + Sync,

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

Struct OtaClient

pub fn download_pr_artifact<F>( &self, pr_number: u32, progress_callback: F, ) -> Result<PathBuf, OtaError>
where F: FnMut(OtaProgress),

pub fn download_default_branch_artifact<F>( &self, progress_callback: F, ) -> Result<PathBuf, OtaError>
where F: FnMut(OtaProgress),

pub fn download_stable_release_artifact<F>( &self, progress_callback: F, ) -> Result<PathBuf, OtaError>
where F: FnMut(OtaProgress),

fn download_by_url_to_path<F>( &self, url: &str, total_size: u64, download_path: &PathBuf, progress_callback: &mut F, use_auth: bool, ) -> Result<(), OtaError>
where F: FnMut(OtaProgress),

fn download_artifact_to_path<F>( &self, artifact: &Artifact, download_path: &PathBuf, progress_callback: &mut F, ) -> Result<(), OtaError>
where F: FnMut(OtaProgress),

fn download_release_asset<F>( &self, asset: &ReleaseAsset, download_path: &PathBuf, progress_callback: &mut F, ) -> Result<(), OtaError>
where F: FnMut(OtaProgress),

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> Downcast for T
where T: Any,

impl<T> DowncastSend for T
where T: Any + Send,

impl<T> DowncastSync for T
where T: Any + Send + Sync,

impl<T, U> Into<U> for T
where U: From<T>,

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,