Skip to main content

AtomicFileOutput

Struct AtomicFileOutput 

Source
pub struct AtomicFileOutput { /* private fields */ }
Expand description

将完整结果先写入同目录临时文件,再原子替换目标文件。

§Examples

use easypdf_core::AtomicFileOutput;

AtomicFileOutput::new("/tmp/output.pdf")
    .write(b"%PDF-1.4 ...");

Implementations§

Source§

impl AtomicFileOutput

Source

pub fn new(target: impl Into<PathBuf>) -> Self

创建原子文件输出目标。

Source

pub fn target(&self) -> &Path

返回最终目标路径。

Source

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

原子写入完整字节内容。

使用 std::fs::File::sync_all 在重命名前将数据和元数据 刷新到持久存储。

§Errors

创建目录、写入、同步或替换失败时返回错误。

Source

pub fn write_with_fsync(&self, data: &[u8]) -> Result<()>

使用显式 fsync 写入数据,然后原子替换目标。

在 macOS 上映射到 fcntl(F_FULLFSYNC)(通过 Rust 的 std::fs::File::sync_all),在 Linux 上映射到 fdatasync, 在 Windows 上映射到 FlushFileBuffers。全部通过安全 Rust。

§Errors

任何阶段的 I/O 失败时返回错误。

Source

pub fn write_with_backup(&self, data: &[u8]) -> Result<()>

备份现有文件(如果有),然后原子写入新数据。

写入成功则移除备份。写入失败则将备份恢复到原始路径。

备份创建在同目录的 <target>.bak

§Errors

备份创建、写入或恢复失败时返回错误。

Source

pub fn atomic_replace<F>(&self, writer: F) -> Result<()>
where F: FnOnce(&mut Vec<u8>) -> Result<()>,

基于回调的原子写入:调用方填充缓冲区,然后缓冲区 被原子地写入目标。

此模式避免了在内存中两次持有整个输出 (一次用于调用方的缓冲区,一次用于写入调用)。

§Errors

回调失败或原子写入失败时返回错误。

§Examples
use easypdf_core::AtomicFileOutput;

AtomicFileOutput::new("/tmp/output.pdf").atomic_replace(|buf| {
    buf.extend_from_slice(b"%PDF-1.4 ...");
    Ok(())
}).unwrap();

Trait Implementations§

Source§

impl Clone for AtomicFileOutput

Source§

fn clone(&self) -> AtomicFileOutput

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AtomicFileOutput

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

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

Performs the conversion.
Source§

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

Source§

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

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

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

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more