use crate::fs::{Metadata, OpenOptions, Permissions};
use cap_primitives::fs::{is_file_read_write, open_ambient};
use cap_primitives::AmbientAuthority;
#[cfg(not(windows))]
use io_extras::os::rustix::{AsRawFd, FromRawFd, IntoRawFd, RawFd};
#[cfg(not(windows))]
use io_lifetimes::{AsFd, BorrowedFd, OwnedFd};
#[cfg(windows)]
use io_lifetimes::{AsHandle, BorrowedHandle, OwnedHandle};
use std::io::{self, IoSlice, IoSliceMut, Read, Seek, SeekFrom, Write};
use std::path::Path;
use std::{fmt, fs, process};
#[cfg(windows)]
use {
io_extras::os::windows::{
AsHandleOrSocket, AsRawHandleOrSocket, BorrowedHandleOrSocket, IntoRawHandleOrSocket,
OwnedHandleOrSocket, RawHandleOrSocket,
},
std::os::windows::io::{AsRawHandle, FromRawHandle, IntoRawHandle, RawHandle},
};
pub struct File {
pub(crate) std: fs::File,
}
impl File {
#[inline]
pub fn from_std(std: fs::File) -> Self {
Self { std }
}
#[inline]
pub fn into_std(self) -> fs::File {
self.std
}
#[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> {
metadata_from(&self.std)
}
#[inline]
pub fn try_clone(&self) -> io::Result<Self> {
let file = self.std.try_clone()?;
Ok(Self::from_std(file))
}
#[inline]
pub fn set_permissions(&self, perm: Permissions) -> io::Result<()> {
self.std
.set_permissions(permissions_into_std(&self.std, perm)?)
}
#[inline]
pub fn open_ambient<P: AsRef<Path>>(
path: P,
ambient_authority: AmbientAuthority,
) -> io::Result<Self> {
let std = open_ambient(
path.as_ref(),
OpenOptions::new().read(true),
ambient_authority,
)?;
Ok(Self::from_std(std))
}
#[inline]
pub fn create_ambient<P: AsRef<Path>>(
path: P,
ambient_authority: AmbientAuthority,
) -> io::Result<Self> {
let std = open_ambient(
path.as_ref(),
OpenOptions::new().write(true).create(true).truncate(true),
ambient_authority,
)?;
Ok(Self::from_std(std))
}
#[inline]
pub fn open_ambient_with<P: AsRef<Path>>(
path: P,
options: &OpenOptions,
ambient_authority: AmbientAuthority,
) -> io::Result<Self> {
let std = open_ambient(path.as_ref(), options, ambient_authority)?;
Ok(Self::from_std(std))
}
#[must_use]
#[inline]
pub fn options() -> OpenOptions {
OpenOptions::new()
}
}
#[inline]
fn metadata_from(file: &fs::File) -> io::Result<Metadata> {
Metadata::from_file(file)
}
#[inline]
fn permissions_into_std(file: &fs::File, permissions: Permissions) -> io::Result<fs::Permissions> {
permissions.into_std(file)
}
unsafe impl io_lifetimes::views::FilelikeViewType for File {}
#[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(not(windows))]
impl From<OwnedFd> for File {
#[inline]
fn from(fd: OwnedFd) -> Self {
Self::from_std(fs::File::from(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(windows)]
impl From<OwnedHandle> for File {
#[inline]
fn from(handle: OwnedHandle) -> Self {
Self::from_std(fs::File::from(handle))
}
}
#[cfg(not(windows))]
impl AsRawFd for File {
#[inline]
fn as_raw_fd(&self) -> RawFd {
self.std.as_raw_fd()
}
}
#[cfg(not(windows))]
impl AsFd for File {
#[inline]
fn as_fd(&self) -> BorrowedFd<'_> {
self.std.as_fd()
}
}
#[cfg(windows)]
impl AsRawHandle for File {
#[inline]
fn as_raw_handle(&self) -> RawHandle {
self.std.as_raw_handle()
}
}
#[cfg(windows)]
impl AsHandle for File {
#[inline]
fn as_handle(&self) -> BorrowedHandle<'_> {
self.std.as_handle()
}
}
#[cfg(windows)]
impl AsRawHandleOrSocket for File {
#[inline]
fn as_raw_handle_or_socket(&self) -> RawHandleOrSocket {
self.std.as_raw_handle_or_socket()
}
}
#[cfg(windows)]
impl AsHandleOrSocket for File {
#[inline]
fn as_handle_or_socket(&self) -> BorrowedHandleOrSocket<'_> {
self.std.as_handle_or_socket()
}
}
#[cfg(not(windows))]
impl IntoRawFd for File {
#[inline]
fn into_raw_fd(self) -> RawFd {
self.std.into_raw_fd()
}
}
#[cfg(not(windows))]
impl From<File> for OwnedFd {
#[inline]
fn from(file: File) -> OwnedFd {
file.std.into()
}
}
#[cfg(windows)]
impl IntoRawHandle for File {
#[inline]
fn into_raw_handle(self) -> RawHandle {
self.std.into_raw_handle()
}
}
#[cfg(windows)]
impl From<File> for OwnedHandle {
#[inline]
fn from(file: File) -> OwnedHandle {
file.std.into()
}
}
#[cfg(windows)]
impl IntoRawHandleOrSocket for File {
#[inline]
fn into_raw_handle_or_socket(self) -> RawHandleOrSocket {
self.std.into_raw_handle_or_socket()
}
}
#[cfg(windows)]
impl From<File> for OwnedHandleOrSocket {
#[inline]
fn from(file: File) -> Self {
file.std.into()
}
}
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(can_vector)]
#[inline]
fn is_read_vectored(&self) -> bool {
self.std.is_read_vectored()
}
}
impl Read for &File {
#[inline]
fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
(&mut &self.std).read(buf)
}
#[inline]
fn read_vectored(&mut self, bufs: &mut [IoSliceMut]) -> io::Result<usize> {
(&mut &self.std).read_vectored(bufs)
}
#[inline]
fn read_exact(&mut self, buf: &mut [u8]) -> io::Result<()> {
(&mut &self.std).read_exact(buf)
}
#[inline]
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> io::Result<usize> {
(&mut &self.std).read_to_end(buf)
}
#[inline]
fn read_to_string(&mut self, buf: &mut String) -> io::Result<usize> {
(&mut &self.std).read_to_string(buf)
}
#[cfg(can_vector)]
#[inline]
fn is_read_vectored(&self) -> bool {
self.std.is_read_vectored()
}
}
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(can_vector)]
#[inline]
fn is_write_vectored(&self) -> bool {
self.std.is_write_vectored()
}
#[cfg(write_all_vectored)]
#[inline]
fn write_all_vectored(&mut self, bufs: &mut [IoSlice]) -> io::Result<()> {
self.std.write_all_vectored(bufs)
}
}
impl Write for &File {
#[inline]
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
(&mut &self.std).write(buf)
}
#[inline]
fn flush(&mut self) -> io::Result<()> {
(&mut &self.std).flush()
}
#[inline]
fn write_vectored(&mut self, bufs: &[IoSlice]) -> io::Result<usize> {
(&mut &self.std).write_vectored(bufs)
}
#[inline]
fn write_all(&mut self, buf: &[u8]) -> io::Result<()> {
(&mut &self.std).write_all(buf)
}
#[cfg(can_vector)]
#[inline]
fn is_write_vectored(&self) -> bool {
self.std.is_write_vectored()
}
#[cfg(write_all_vectored)]
#[inline]
fn write_all_vectored(&mut self, bufs: &mut [IoSlice]) -> io::Result<()> {
(&mut &self.std).write_all_vectored(bufs)
}
}
impl Seek for File {
#[inline]
fn seek(&mut self, pos: SeekFrom) -> io::Result<u64> {
self.std.seek(pos)
}
#[inline]
fn stream_position(&mut self) -> io::Result<u64> {
self.std.stream_position()
}
}
impl Seek for &File {
#[inline]
fn seek(&mut self, pos: SeekFrom) -> io::Result<u64> {
(&mut &self.std).seek(pos)
}
#[inline]
fn stream_position(&mut self) -> io::Result<u64> {
(&mut &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 crate::fs::FileExt for File {
#[inline]
fn read_at(&self, buf: &mut [u8], offset: u64) -> io::Result<usize> {
std::os::unix::fs::FileExt::read_at(&self.std, buf, offset)
}
#[inline]
fn write_at(&self, buf: &[u8], offset: u64) -> io::Result<usize> {
std::os::unix::fs::FileExt::write_at(&self.std, buf, offset)
}
#[inline]
fn read_exact_at(&self, buf: &mut [u8], offset: u64) -> io::Result<()> {
std::os::unix::fs::FileExt::read_exact_at(&self.std, buf, offset)
}
#[inline]
fn write_all_at(&self, buf: &[u8], offset: u64) -> io::Result<()> {
std::os::unix::fs::FileExt::write_all_at(&self.std, buf, offset)
}
}
#[cfg(target_os = "wasi")]
impl crate::fs::FileExt for File {
#[inline]
fn read_at(&self, bufs: &mut [u8], offset: u64) -> io::Result<usize> {
std::os::wasi::fs::FileExt::read_at(&self.std, bufs, offset)
}
#[inline]
fn write_at(&self, bufs: &[u8], offset: u64) -> io::Result<usize> {
std::os::wasi::fs::FileExt::write_at(&self.std, bufs, offset)
}
#[inline]
fn read_vectored_at(&self, bufs: &mut [IoSliceMut], offset: u64) -> io::Result<usize> {
std::os::wasi::fs::FileExt::read_vectored_at(&self.std, bufs, offset)
}
#[inline]
fn write_vectored_at(&self, bufs: &[IoSlice], offset: u64) -> io::Result<usize> {
std::os::wasi::fs::FileExt::write_vectored_at(&self.std, bufs, offset)
}
#[inline]
fn tell(&self) -> std::result::Result<u64, io::Error> {
std::os::wasi::fs::FileExt::tell(&self.std)
}
#[inline]
fn fdstat_set_flags(&self, flags: u16) -> std::result::Result<(), io::Error> {
std::os::wasi::fs::FileExt::fdstat_set_flags(&self.std, flags)
}
#[inline]
fn fdstat_set_rights(
&self,
rights: u64,
inheriting: u64,
) -> std::result::Result<(), io::Error> {
std::os::wasi::fs::FileExt::fdstat_set_rights(&self.std, rights, inheriting)
}
#[inline]
fn advise(&self, offset: u64, len: u64, advice: u8) -> std::result::Result<(), io::Error> {
std::os::wasi::fs::FileExt::advise(&self.std, offset, len, advice)
}
#[inline]
fn allocate(&self, offset: u64, len: u64) -> std::result::Result<(), io::Error> {
std::os::wasi::fs::FileExt::allocate(&self.std, offset, len)
}
#[inline]
fn create_directory<P: AsRef<Path>>(&self, dir: P) -> std::result::Result<(), io::Error> {
std::os::wasi::fs::FileExt::create_directory(&self.std, dir)
}
#[inline]
fn read_link<P: AsRef<Path>>(
&self,
path: P,
) -> std::result::Result<std::path::PathBuf, io::Error> {
std::os::wasi::fs::FileExt::read_link(&self.std, path)
}
#[inline]
fn metadata_at<P: AsRef<Path>>(
&self,
lookup_flags: u32,
path: P,
) -> std::result::Result<std::fs::Metadata, io::Error> {
std::os::wasi::fs::FileExt::metadata_at(&self.std, lookup_flags, path)
}
#[inline]
fn remove_file<P: AsRef<Path>>(&self, path: P) -> std::result::Result<(), io::Error> {
std::os::wasi::fs::FileExt::remove_file(&self.std, path)
}
#[inline]
fn remove_directory<P: AsRef<Path>>(&self, path: P) -> std::result::Result<(), io::Error> {
std::os::wasi::fs::FileExt::remove_directory(&self.std, path)
}
}
#[cfg(windows)]
impl crate::fs::FileExt for File {
#[inline]
fn seek_read(&self, buf: &mut [u8], offset: u64) -> io::Result<usize> {
std::os::windows::fs::FileExt::seek_read(&self.std, buf, offset)
}
#[inline]
fn seek_write(&self, buf: &[u8], offset: u64) -> io::Result<usize> {
std::os::windows::fs::FileExt::seek_write(&self.std, 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_file_read_write(&self.std) {
b.field("read", &read).field("write", &write);
}
b.finish()
}
}