esp_idf_svc::ota

Struct EspOtaUpdate

Source
pub struct EspOtaUpdate<'a> { /* private fields */ }

Implementations§

Source§

impl<'a> EspOtaUpdate<'a>

Source

pub fn write(&mut self, buf: &[u8]) -> Result<(), EspError>

Writes OTA update data to partition. This function can be called multiple times as data is received during the OTA operation. Data is written sequentially to the partition.

§Errors

Returns an error if data could not be written to flash.

Source

pub fn flush(&mut self) -> Result<(), EspError>

This function does not perform any flash operations, as flash writes are not cached and, therefore, do not need to be flushed.

§Errors

Returns an error update partition is not valid.

Source

pub fn finish(self) -> Result<EspOtaUpdateFinished<'a>, EspError>

Finishes the OTA update and validates the new app image. Returns an instance of EspOtaUpdateFinished.

This function does not update the boot partition. The user must call activate() on the returned instance of EspOtaUpdateFinished.

See also: complete

Source

pub fn complete(self) -> Result<(), EspError>

Completes the OTA process by validating the new app image and updating the boot partition.

Source

pub fn abort(self) -> Result<(), EspError>

Cancels the update.

Trait Implementations§

Source§

impl<'a> Debug for EspOtaUpdate<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for EspOtaUpdate<'_>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl ErrorType for EspOtaUpdate<'_>

Source§

type Error = EspIOError

Error type of all the IO operations on this type.
Source§

impl<'a> OtaUpdate for EspOtaUpdate<'a>

Source§

type OtaUpdateFinished = EspOtaUpdateFinished<'a>

Source§

fn finish(self) -> Result<Self::OtaUpdateFinished, Self::Error>

Source§

fn complete(self) -> Result<(), Self::Error>

Source§

fn abort(self) -> Result<(), Self::Error>

Source§

fn update<R>( self, read: R, progress: impl Fn(u64, u64), ) -> Result<(), CopyError<<R as ErrorType>::Error, Self::Error>>
where R: Read, Self: Sized,

Source§

impl Write for EspOtaUpdate<'_>

Source§

fn write(&mut self, buf: &[u8]) -> Result<usize, Self::Error>

Write a buffer into this writer, returning how many bytes were written. Read more
Source§

fn flush(&mut self) -> Result<(), Self::Error>

Flush this output stream, blocking until all intermediately buffered contents reach their destination.
Source§

fn write_all(&mut self, buf: &[u8]) -> Result<(), Self::Error>

Write an entire buffer into this writer. Read more
Source§

fn write_fmt( &mut self, fmt: Arguments<'_>, ) -> Result<(), WriteFmtError<Self::Error>>

Write a formatted string into this writer, returning any error encountered. Read more
Source§

impl Send for EspOtaUpdate<'_>

Auto Trait Implementations§

§

impl<'a> Freeze for EspOtaUpdate<'a>

§

impl<'a> RefUnwindSafe for EspOtaUpdate<'a>

§

impl<'a> !Sync for EspOtaUpdate<'a>

§

impl<'a> Unpin for EspOtaUpdate<'a>

§

impl<'a> !UnwindSafe for EspOtaUpdate<'a>

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

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

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.