#[cfg(feature = "with_options")]
use crate::fs::OpenOptions;
use crate::fs::{Metadata, Permissions};
use cap_primitives::fs::is_read_write;
#[cfg(feature = "read_initializer")]
use std::io::Initializer;
#[cfg(unix)]
use std::os::unix::io::{AsRawFd, FromRawFd, IntoRawFd, RawFd};
#[cfg(target_os = "wasi")]
use std::os::wasi::io::{AsRawFd, FromRawFd, IntoRawFd, RawFd};
#[cfg(windows)]
use std::os::windows::io::{AsRawHandle, FromRawHandle, IntoRawHandle, RawHandle};
#[cfg(target_os = "wasi")]
use std::path::Path;
use std::{
fmt, fs,
io::{self, IoSlice, IoSliceMut, Read, Seek, SeekFrom, Write},
process,
};
pub struct File {
pub(crate) std: fs::File,
}
impl File {
#[inline]
pub fn from_std(std: fs::File) -> Self {
Self { std }
}
#[inline]
#[cfg(feature = "with_options")]
pub fn with_options() -> OpenOptions {
OpenOptions::new()
}
#[inline]
pub fn sync_all(&self) -> io::Result<()> {
self.std.sync_all()
}
#[inline]
pub fn sync_data(&self) -> io::Result<()> {
self.std.sync_data()
}
#[inline]
pub fn set_len(&self, size: u64) -> io::Result<()> {
self.std.set_len(size)
}
#[inline]
pub fn metadata(&self) -> io::Result<Metadata> {
self.std.metadata().map(metadata_from_std)
}
#[inline]
pub fn try_clone(&self) -> io::Result<Self> {
Ok(Self::from_std(self.std.try_clone()?))
}
#[inline]
pub fn set_permissions(&self, perm: Permissions) -> io::Result<()> {
self.std
.set_permissions(permissions_into_std(&self.std, perm)?)
}
}
#[cfg(not(target_os = "wasi"))]
#[inline]
fn metadata_from_std(metadata: fs::Metadata) -> Metadata {
Metadata::from_std(metadata)
}
#[cfg(target_os = "wasi")]
#[inline]
fn metadata_from_std(metadata: fs::Metadata) -> Metadata {
metadata
}
#[cfg(not(target_os = "wasi"))]
#[inline]
fn permissions_into_std(file: &fs::File, permissions: Permissions) -> io::Result<fs::Permissions> {
permissions.into_std(file)
}
#[cfg(target_os = "wasi")]
#[inline]
fn permissions_into_std(_file: &fs::File, permissions: Permissions) -> io::Result<fs::Permissions> {
permissions
}
#[cfg(not(windows))]
impl FromRawFd for File {
#[inline]
unsafe fn from_raw_fd(fd: RawFd) -> Self {
Self::from_std(fs::File::from_raw_fd(fd))
}
}
#[cfg(windows)]
impl FromRawHandle for File {
#[inline]
unsafe fn from_raw_handle(handle: RawHandle) -> Self {
Self::from_std(fs::File::from_raw_handle(handle))
}
}
#[cfg(not(windows))]
impl AsRawFd for File {
#[inline]
fn as_raw_fd(&self) -> RawFd {
self.std.as_raw_fd()
}
}
#[cfg(windows)]
impl AsRawHandle for File {
#[inline]
fn as_raw_handle(&self) -> RawHandle {
self.std.as_raw_handle()
}
}
#[cfg(not(windows))]
impl IntoRawFd for File {
#[inline]
fn into_raw_fd(self) -> RawFd {
self.std.into_raw_fd()
}
}
#[cfg(windows)]
impl IntoRawHandle for File {
#[inline]
fn into_raw_handle(self) -> RawHandle {
self.std.into_raw_handle()
}
}
impl Read for File {
#[inline]
fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
self.std.read(buf)
}
#[inline]
fn read_vectored(&mut self, bufs: &mut [IoSliceMut]) -> io::Result<usize> {
self.std.read_vectored(bufs)
}
#[inline]
fn read_exact(&mut self, buf: &mut [u8]) -> io::Result<()> {
self.std.read_exact(buf)
}
#[inline]
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> io::Result<usize> {
self.std.read_to_end(buf)
}
#[inline]
fn read_to_string(&mut self, buf: &mut String) -> io::Result<usize> {
self.std.read_to_string(buf)
}
#[cfg(feature = "can_vector")]
#[inline]
fn is_read_vectored(&self) -> bool {
self.std.is_read_vectored()
}
#[cfg(feature = "read_initializer")]
#[inline]
unsafe fn initializer(&self) -> Initializer {
self.std.initializer()
}
}
impl Write for File {
#[inline]
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
self.std.write(buf)
}
#[inline]
fn flush(&mut self) -> io::Result<()> {
self.std.flush()
}
#[inline]
fn write_vectored(&mut self, bufs: &[IoSlice]) -> io::Result<usize> {
self.std.write_vectored(bufs)
}
#[inline]
fn write_all(&mut self, buf: &[u8]) -> io::Result<()> {
self.std.write_all(buf)
}
#[cfg(feature = "can_vector")]
#[inline]
fn is_write_vectored(&self) -> bool {
self.std.is_write_vectored()
}
#[cfg(feature = "write_all_vectored")]
#[inline]
fn write_all_vectored(&mut self, bufs: &mut [IoSlice]) -> io::Result<()> {
self.std.write_all_vectored(bufs)
}
}
impl Seek for File {
#[inline]
fn seek(&mut self, pos: SeekFrom) -> io::Result<u64> {
self.std.seek(pos)
}
#[cfg(feature = "seek_convenience")]
#[inline]
fn stream_len(&mut self) -> io::Result<u64> {
self.std.stream_len()
}
#[cfg(feature = "seek_convenience")]
#[inline]
fn stream_position(&mut self) -> io::Result<u64> {
self.std.stream_position()
}
}
impl From<File> for process::Stdio {
#[inline]
fn from(file: File) -> Self {
From::<fs::File>::from(file.std)
}
}
#[cfg(unix)]
impl std::os::unix::fs::FileExt for File {
#[inline]
fn read_at(&self, buf: &mut [u8], offset: u64) -> io::Result<usize> {
self.std.read_at(buf, offset)
}
#[inline]
fn write_at(&self, buf: &[u8], offset: u64) -> io::Result<usize> {
self.std.write_at(buf, offset)
}
#[inline]
fn read_exact_at(&self, buf: &mut [u8], offset: u64) -> io::Result<()> {
self.std.read_exact_at(buf, offset)
}
#[inline]
fn write_all_at(&self, buf: &[u8], offset: u64) -> io::Result<()> {
self.std.write_all_at(buf, offset)
}
}
#[cfg(target_os = "wasi")]
impl std::os::wasi::fs::FileExt for File {
#[inline]
fn read_at(&self, bufs: &mut [IoSliceMut], offset: u64) -> io::Result<usize> {
self.std.read_at(bufs, offset)
}
#[inline]
fn write_at(&self, bufs: &[IoSlice], offset: u64) -> io::Result<usize> {
self.std.write_at(bufs, offset)
}
#[inline]
fn tell(&self) -> std::result::Result<u64, std::io::Error> {
self.std.tell()
}
#[inline]
fn fdstat_set_flags(&self, flags: u16) -> std::result::Result<(), std::io::Error> {
self.std.fdstat_set_flags(flags)
}
#[inline]
fn fdstat_set_rights(
&self,
rights: u64,
inheriting: u64,
) -> std::result::Result<(), std::io::Error> {
self.std.fdstat_set_rights(rights, inheriting)
}
#[inline]
fn advise(&self, offset: u64, len: u64, advice: u8) -> std::result::Result<(), std::io::Error> {
self.std.advise(offset, len, advice)
}
#[inline]
fn allocate(&self, offset: u64, len: u64) -> std::result::Result<(), std::io::Error> {
self.std.allocate(offset, len)
}
#[inline]
fn create_directory<P: AsRef<Path>>(&self, dir: P) -> std::result::Result<(), std::io::Error> {
self.std.create_directory(dir)
}
#[inline]
fn read_link<P: AsRef<Path>>(
&self,
path: P,
) -> std::result::Result<std::path::PathBuf, std::io::Error> {
self.std.read_link(path)
}
#[inline]
fn metadata_at<P: AsRef<Path>>(
&self,
lookup_flags: u32,
path: P,
) -> std::result::Result<std::fs::Metadata, std::io::Error> {
self.std.metadata_at(lookup_flags, path)
}
#[inline]
fn remove_file<P: AsRef<Path>>(&self, path: P) -> std::result::Result<(), std::io::Error> {
self.std.remove_file(path)
}
#[inline]
fn remove_directory<P: AsRef<Path>>(&self, path: P) -> std::result::Result<(), std::io::Error> {
self.std.remove_directory(path)
}
}
#[cfg(windows)]
impl std::os::windows::fs::FileExt for File {
#[inline]
fn seek_read(&self, buf: &mut [u8], offset: u64) -> io::Result<usize> {
self.std.seek_read(buf, offset)
}
#[inline]
fn seek_write(&self, buf: &[u8], offset: u64) -> io::Result<usize> {
self.std.seek_write(buf, offset)
}
}
impl fmt::Debug for File {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let mut b = f.debug_struct("File");
#[cfg(not(windows))]
b.field("fd", &self.std.as_raw_fd());
#[cfg(windows)]
b.field("handle", &self.std.as_raw_handle());
if let Ok((read, write)) = is_read_write(&self.std) {
b.field("read", &read).field("write", &write);
}
b.finish()
}
}