1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
use crate::buf::fixed::FixedBuf;
use crate::buf::{BoundedBuf, BoundedBufMut, IoBuf, IoBufMut, Slice};
use crate::fs::OpenOptions;
use crate::io::SharedFd;
use crate::runtime::driver::op::Op;
use crate::{UnsubmittedOneshot, UnsubmittedWrite};
use std::fmt;
use std::io;
use std::os::unix::io::{AsRawFd, FromRawFd, IntoRawFd, RawFd};
use std::path::Path;
/// A reference to an open file on the filesystem.
///
/// An instance of a `File` can be read and/or written depending on what options
/// it was opened with. The `File` type provides **positional** read and write
/// operations. The file does not maintain an internal cursor. The caller is
/// required to specify an offset when issuing an operation.
///
/// While files are automatically closed when they go out of scope, the
/// operation happens asynchronously in the background. It is recommended to
/// call the `close()` function in order to guarantee that the file successfully
/// closed before exiting the scope. Closing a file does not guarantee writes
/// have persisted to disk. Use [`sync_all`] to ensure all writes have reached
/// the filesystem.
///
/// [`sync_all`]: File::sync_all
///
/// # Examples
///
/// Creates a new file and write data to it:
///
/// ```no_run
/// use tokio_uring::fs::File;
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// tokio_uring::start(async {
/// // Open a file
/// let file = File::create("hello.txt").await?;
///
/// // Write some data
/// let (res, buf) = file.write_at(&b"hello world"[..], 0).submit().await;
/// let n = res?;
///
/// println!("wrote {} bytes", n);
///
/// // Sync data to the file system.
/// file.sync_all().await?;
///
/// // Close the file
/// file.close().await?;
///
/// Ok(())
/// })
/// }
/// ```
pub struct File {
/// Open file descriptor
pub(crate) fd: SharedFd,
}
impl File {
/// Attempts to open a file in read-only mode.
///
/// See the [`OpenOptions::open`] method for more details.
///
/// # Errors
///
/// This function will return an error if `path` does not already exist.
/// Other errors may also be returned according to [`OpenOptions::open`].
///
/// # Examples
///
/// ```no_run
/// use tokio_uring::fs::File;
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// tokio_uring::start(async {
/// let f = File::open("foo.txt").await?;
///
/// // Close the file
/// f.close().await?;
/// Ok(())
/// })
/// }
/// ```
pub async fn open(path: impl AsRef<Path>) -> io::Result<File> {
OpenOptions::new().read(true).open(path).await
}
/// Opens a file in write-only mode.
///
/// This function will create a file if it does not exist,
/// and will truncate it if it does.
///
/// See the [`OpenOptions::open`] function for more details.
///
/// # Examples
///
/// ```no_run
/// use tokio_uring::fs::File;
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// tokio_uring::start(async {
/// let f = File::create("foo.txt").await?;
///
/// // Close the file
/// f.close().await?;
/// Ok(())
/// })
/// }
/// ```
pub async fn create(path: impl AsRef<Path>) -> io::Result<File> {
OpenOptions::new()
.write(true)
.create(true)
.truncate(true)
.open(path)
.await
}
pub(crate) fn from_shared_fd(fd: SharedFd) -> File {
File { fd }
}
/// Converts a [`std::fs::File`][std] to a [`tokio_uring::fs::File`][file].
///
/// [std]: std::fs::File
/// [file]: File
pub fn from_std(file: std::fs::File) -> File {
File::from_shared_fd(SharedFd::new(file.into_raw_fd()))
}
/// Read some bytes at the specified offset from the file into the specified
/// buffer, returning how many bytes were read.
///
/// # Return
///
/// The method returns the operation result and the same buffer value passed
/// as an argument.
///
/// If the method returns [`Ok(n)`], then the read was successful. A nonzero
/// `n` value indicates that the buffer has been filled with `n` bytes of
/// data from the file. If `n` is `0`, then one of the following happened:
///
/// 1. The specified offset is the end of the file.
/// 2. The buffer specified was 0 bytes in length.
///
/// It is not an error if the returned value `n` is smaller than the buffer
/// size, even when the file contains enough data to fill the buffer.
///
/// # Errors
///
/// If this function encounters any form of I/O or other error, an error
/// variant will be returned. The buffer is returned on error.
///
/// # Examples
///
/// ```no_run
/// use tokio_uring::fs::File;
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// tokio_uring::start(async {
/// let f = File::open("foo.txt").await?;
/// let buffer = vec![0; 10];
///
/// // Read up to 10 bytes
/// let (res, buffer) = f.read_at(buffer, 0).await;
/// let n = res?;
///
/// println!("The bytes: {:?}", &buffer[..n]);
///
/// // Close the file
/// f.close().await?;
/// Ok(())
/// })
/// }
/// ```
pub async fn read_at<T: BoundedBufMut>(&self, buf: T, pos: u64) -> crate::BufResult<usize, T> {
// Submit the read operation
let op = Op::read_at(&self.fd, buf, pos).unwrap();
op.await
}
/// Read some bytes at the specified offset from the file into the specified
/// array of buffers, returning how many bytes were read.
///
/// # Return
///
/// The method returns the operation result and the same array of buffers
/// passed as an argument.
///
/// If the method returns [`Ok(n)`], then the read was successful. A nonzero
/// `n` value indicates that the buffers have been filled with `n` bytes of
/// data from the file. If `n` is `0`, then one of the following happened:
///
/// 1. The specified offset is the end of the file.
/// 2. The buffers specified were 0 bytes in length.
///
/// It is not an error if the returned value `n` is smaller than the buffer
/// size, even when the file contains enough data to fill the buffer.
///
/// # Errors
///
/// If this function encounters any form of I/O or other error, an error
/// variant will be returned. The buffer is returned on error.
///
/// # Examples
///
/// ```no_run
/// use tokio_uring::fs::File;
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// tokio_uring::start(async {
/// let f = File::open("foo.txt").await?;
/// let buffers = vec![Vec::<u8>::with_capacity(10), Vec::<u8>::with_capacity(10)];
///
/// // Read up to 20 bytes
/// let (res, buffer) = f.readv_at(buffers, 0).await;
/// let n = res?;
///
/// println!("Read {} bytes", n);
///
/// // Close the file
/// f.close().await?;
/// Ok(())
/// })
/// }
/// ```
pub async fn readv_at<T: BoundedBufMut>(
&self,
bufs: Vec<T>,
pos: u64,
) -> crate::BufResult<usize, Vec<T>> {
// Submit the read operation
let op = Op::readv_at(&self.fd, bufs, pos).unwrap();
op.await
}
/// Write data from buffers into this file at the specified offset,
/// returning how many bytes were written.
///
/// This function will attempt to write the entire contents of `bufs`, but
/// the entire write may not succeed, or the write may also generate an
/// error. The bytes will be written starting at the specified offset.
///
/// # Return
///
/// The method returns the operation result and the same array of buffers passed
/// in as an argument. A return value of `0` typically means that the
/// underlying file is no longer able to accept bytes and will likely not be
/// able to in the future as well, or that the buffer provided is empty.
///
/// # Errors
///
/// Each call to `write` may generate an I/O error indicating that the
/// operation could not be completed. If an error is returned then no bytes
/// in the buffer were written to this writer.
///
/// It is **not** considered an error if the entire buffer could not be
/// written to this writer.
///
/// # Examples
///
/// ```no_run
/// use tokio_uring::fs::File;
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// tokio_uring::start(async {
/// let file = File::create("foo.txt").await?;
///
/// // Writes some prefix of the byte string, not necessarily all of it.
/// let bufs = vec!["some".to_owned().into_bytes(), " bytes".to_owned().into_bytes()];
/// let (res, _) = file.writev_at(bufs, 0).await;
/// let n = res?;
///
/// println!("wrote {} bytes", n);
///
/// // Close the file
/// file.close().await?;
/// Ok(())
/// })
/// }
/// ```
///
/// [`Ok(n)`]: Ok
pub async fn writev_at<T: BoundedBuf>(
&self,
buf: Vec<T>,
pos: u64,
) -> crate::BufResult<usize, Vec<T>> {
let op = Op::writev_at(&self.fd, buf, pos).unwrap();
op.await
}
/// Like `writev_at` but will call the `io_uring` `writev` operation multiple times if
/// necessary.
///
/// Parameter `pos` is an `Option<u64>` to allow this function to be used for both files that
/// are seekable and those that are not. The caller is responsible for knowing this.
///
/// When `None` is supplied, the offset passed to the `io_uring` call will always be zero, even
/// if multiple writev calls are necessary; only the iovec information would be adjusted
/// between calls. A Unix pipe would fall into this category.
///
/// When `Some(n)` is suppied, the offset passed to the writev call will be incremented by the
/// progress of prior writev calls. A file system's regular file would fall into this category.
///
/// If the caller passes `Some(n)` for a file that is not seekable, the `io_uring` `writev`
/// operation will return an error once n is not zero.
///
/// If the caller passes `None`, when the file *is* seekable, when multiple `writev` calls are
/// required to complete the writing of all the bytes, the bytes at position 0 of the file will
/// have been overwritten one or more times with incorrect data. This is true just as if the
/// caller had invoked seperate write calls to a file, all with position 0, when in fact the
/// file was seekable.
///
/// Performance considerations:
///
/// The user may want to check that this function is necessary in their use case or performs
/// better than a series of write_all operations would. There is overhead either way and it is
/// not clear which should be faster or give better throughput.
///
/// This function causes the temporary allocation of a Vec one time to hold the array of iovec
/// that is passed to the kernel. The same array is used for any subsequent calls to get all
/// the bytes written. Whereas individual calls to write_all do not require the Vec to be
/// allocated, they do each incur the normal overhead of setting up the submission and
/// completion structures and going through the future poll mechanism.
///
/// TODO decide, would a separate `writev_all` function for `file` that did not take a `pos`
/// make things less ambiguous?
///
/// TODO more complete documentation here.
/// TODO define writev_all functions for net/unix/stream, net/tcp/stream, io/socket.
/// TODO remove usize from result, to be consistent with other write_all_vectored functions.
/// TODO find a way to test this with some stress to the file so the writev calls don't all
/// succeed on their first try.
/// TODO consider replacing the current `write_all` and `write_all_at` functions with a similar
/// mechanism so all the write-all logic is in one place, in the io/write_all.rs file.
pub async fn writev_at_all<T: BoundedBuf>(
&self,
buf: Vec<T>,
pos: Option<u64>, // Use None for files that can't seek
) -> crate::BufResult<usize, Vec<T>> {
let op = crate::io::writev_at_all(&self.fd, buf, pos);
op.await
}
/// Read the exact number of bytes required to fill `buf` at the specified
/// offset from the file.
///
/// This function reads as many as bytes as necessary to completely fill the
/// specified buffer `buf`.
///
/// # Return
///
/// The method returns the operation result and the same buffer value passed
/// as an argument.
///
/// If the method returns [`Ok(())`], then the read was successful.
///
/// # Errors
///
/// If this function encounters an "end of file" before completely filling
/// the buffer, it returns an error of the kind [`ErrorKind::UnexpectedEof`].
/// The buffer is returned on error.
///
/// If this function encounters any form of I/O or other error, an error
/// variant will be returned. The buffer is returned on error.
///
/// # Examples
///
/// ```no_run
/// use tokio_uring::fs::File;
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// tokio_uring::start(async {
/// let f = File::open("foo.txt").await?;
/// let buffer = Vec::with_capacity(10);
///
/// // Read up to 10 bytes
/// let (res, buffer) = f.read_exact_at(buffer, 0).await;
/// res?;
///
/// println!("The bytes: {:?}", buffer);
///
/// // Close the file
/// f.close().await?;
/// Ok(())
/// })
/// }
/// ```
///
/// [`ErrorKind::UnexpectedEof`]: std::io::ErrorKind::UnexpectedEof
pub async fn read_exact_at<T>(&self, buf: T, pos: u64) -> crate::BufResult<(), T>
where
T: BoundedBufMut,
{
let orig_bounds = buf.bounds();
let (res, buf) = self.read_exact_slice_at(buf.slice_full(), pos).await;
(res, T::from_buf_bounds(buf, orig_bounds))
}
async fn read_exact_slice_at<T: IoBufMut>(
&self,
mut buf: Slice<T>,
mut pos: u64,
) -> crate::BufResult<(), T> {
if pos.checked_add(buf.bytes_total() as u64).is_none() {
return (
Err(io::Error::new(
io::ErrorKind::InvalidInput,
"buffer too large for file",
)),
buf.into_inner(),
);
}
while buf.bytes_total() != 0 {
let (res, slice) = self.read_at(buf, pos).await;
match res {
Ok(0) => {
return (
Err(io::Error::new(
io::ErrorKind::UnexpectedEof,
"failed to fill whole buffer",
)),
slice.into_inner(),
)
}
Ok(n) => {
pos += n as u64;
buf = slice.slice(n..);
}
// No match on an EINTR error is performed because this
// crate's design ensures we are not calling the 'wait' option
// in the ENTER syscall. Only an Enter with 'wait' can generate
// an EINTR according to the io_uring man pages.
Err(e) => return (Err(e), slice.into_inner()),
};
}
(Ok(()), buf.into_inner())
}
/// Like [`read_at`], but using a pre-mapped buffer
/// registered with [`FixedBufRegistry`].
///
/// [`read_at`]: Self::read_at
/// [`FixedBufRegistry`]: crate::buf::fixed::FixedBufRegistry
///
/// # Errors
///
/// In addition to errors that can be reported by `read_at`,
/// this operation fails if the buffer is not registered in the
/// current `tokio-uring` runtime.
///
/// # Examples
///
/// ```no_run
///# fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use tokio_uring::fs::File;
/// use tokio_uring::buf::fixed::FixedBufRegistry;
/// use tokio_uring::buf::BoundedBuf;
/// use std::iter;
///
/// tokio_uring::start(async {
/// let registry = FixedBufRegistry::new(iter::repeat(vec![0; 10]).take(10));
/// registry.register()?;
///
/// let f = File::open("foo.txt").await?;
/// let buffer = registry.check_out(2).unwrap();
///
/// // Read up to 10 bytes
/// let (res, buffer) = f.read_fixed_at(buffer, 0).await;
/// let n = res?;
///
/// println!("The bytes: {:?}", &buffer[..n]);
///
/// // Close the file
/// f.close().await?;
/// Ok(())
/// })
///# }
/// ```
pub async fn read_fixed_at<T>(&self, buf: T, pos: u64) -> crate::BufResult<usize, T>
where
T: BoundedBufMut<BufMut = FixedBuf>,
{
// Submit the read operation
let op = Op::read_fixed_at(&self.fd, buf, pos).unwrap();
op.await
}
/// Write a buffer into this file at the specified offset, returning how
/// many bytes were written.
///
/// This function will attempt to write the entire contents of `buf`, but
/// the entire write may not succeed, or the write may also generate an
/// error. The bytes will be written starting at the specified offset.
///
/// # Return
///
/// The method returns the operation result and the same buffer value passed
/// in as an argument. A return value of `0` typically means that the
/// underlying file is no longer able to accept bytes and will likely not be
/// able to in the future as well, or that the buffer provided is empty.
///
/// # Errors
///
/// Each call to `write` may generate an I/O error indicating that the
/// operation could not be completed. If an error is returned then no bytes
/// in the buffer were written to this writer.
///
/// It is **not** considered an error if the entire buffer could not be
/// written to this writer.
///
/// # Examples
///
/// ```no_run
/// use tokio_uring::fs::File;
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// tokio_uring::start(async {
/// let file = File::create("foo.txt").await?;
///
/// // Writes some prefix of the byte string, not necessarily all of it.
/// let (res, _) = file.write_at(&b"some bytes"[..], 0).submit().await;
/// let n = res?;
///
/// println!("wrote {} bytes", n);
///
/// // Close the file
/// file.close().await?;
/// Ok(())
/// })
/// }
/// ```
///
/// [`Ok(n)`]: Ok
pub fn write_at<T: BoundedBuf>(&self, buf: T, pos: u64) -> UnsubmittedWrite<T> {
UnsubmittedOneshot::write_at(&self.fd, buf, pos)
}
/// Attempts to write an entire buffer into this file at the specified offset.
///
/// This method will continuously call [`write_at`] until there is no more data
/// to be written or an error is returned.
/// This method will not return until the entire buffer has been successfully
/// written or an error occurs.
///
/// If the buffer contains no data, this will never call [`write_at`].
///
/// # Return
///
/// The method returns the operation result and the same buffer value passed
/// in as an argument.
///
/// # Errors
///
/// This function will return the first error that [`write_at`] returns.
///
/// # Examples
///
/// ```no_run
/// use tokio_uring::fs::File;
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// tokio_uring::start(async {
/// let file = File::create("foo.txt").await?;
///
/// // Writes some prefix of the byte string, not necessarily all of it.
/// let (res, _) = file.write_all_at(&b"some bytes"[..], 0).await;
/// res?;
///
/// println!("wrote all bytes");
///
/// // Close the file
/// file.close().await?;
/// Ok(())
/// })
/// }
/// ```
///
/// [`write_at`]: File::write_at
pub async fn write_all_at<T>(&self, buf: T, pos: u64) -> crate::BufResult<(), T>
where
T: BoundedBuf,
{
let orig_bounds = buf.bounds();
let (res, buf) = self.write_all_slice_at(buf.slice_full(), pos).await;
(res, T::from_buf_bounds(buf, orig_bounds))
}
async fn write_all_slice_at<T: IoBuf>(
&self,
mut buf: Slice<T>,
mut pos: u64,
) -> crate::BufResult<(), T> {
if pos.checked_add(buf.bytes_init() as u64).is_none() {
return (
Err(io::Error::new(
io::ErrorKind::InvalidInput,
"buffer too large for file",
)),
buf.into_inner(),
);
}
while buf.bytes_init() != 0 {
let (res, slice) = self.write_at(buf, pos).submit().await;
match res {
Ok(0) => {
return (
Err(io::Error::new(
io::ErrorKind::WriteZero,
"failed to write whole buffer",
)),
slice.into_inner(),
)
}
Ok(n) => {
pos += n as u64;
buf = slice.slice(n..);
}
// No match on an EINTR error is performed because this
// crate's design ensures we are not calling the 'wait' option
// in the ENTER syscall. Only an Enter with 'wait' can generate
// an EINTR according to the io_uring man pages.
Err(e) => return (Err(e), slice.into_inner()),
};
}
(Ok(()), buf.into_inner())
}
/// Like [`write_at`], but using a pre-mapped buffer
/// registered with [`FixedBufRegistry`].
///
/// [`write_at`]: Self::write_at
/// [`FixedBufRegistry`]: crate::buf::fixed::FixedBufRegistry
///
/// # Errors
///
/// In addition to errors that can be reported by `write_at`,
/// this operation fails if the buffer is not registered in the
/// current `tokio-uring` runtime.
///
/// # Examples
///
/// ```no_run
///# fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use tokio_uring::fs::File;
/// use tokio_uring::buf::fixed::FixedBufRegistry;
/// use tokio_uring::buf::BoundedBuf;
///
/// tokio_uring::start(async {
/// let registry = FixedBufRegistry::new([b"some bytes".to_vec()]);
/// registry.register()?;
///
/// let file = File::create("foo.txt").await?;
///
/// let buffer = registry.check_out(0).unwrap();
///
/// // Writes some prefix of the buffer content,
/// // not necessarily all of it.
/// let (res, _) = file.write_fixed_at(buffer, 0).await;
/// let n = res?;
///
/// println!("wrote {} bytes", n);
///
/// // Close the file
/// file.close().await?;
/// Ok(())
/// })
///# }
/// ```
pub async fn write_fixed_at<T>(&self, buf: T, pos: u64) -> crate::BufResult<usize, T>
where
T: BoundedBuf<Buf = FixedBuf>,
{
let op = Op::write_fixed_at(&self.fd, buf, pos).unwrap();
op.await
}
/// Attempts to write an entire buffer into this file at the specified offset.
///
/// This method will continuously call [`write_fixed_at`] until there is no more data
/// to be written or an error is returned.
/// This method will not return until the entire buffer has been successfully
/// written or an error occurs.
///
/// If the buffer contains no data, this will never call [`write_fixed_at`].
///
/// # Return
///
/// The method returns the operation result and the same buffer value passed
/// in as an argument.
///
/// # Errors
///
/// This function will return the first error that [`write_fixed_at`] returns.
///
/// [`write_fixed_at`]: Self::write_fixed_at
pub async fn write_fixed_all_at<T>(&self, buf: T, pos: u64) -> crate::BufResult<(), T>
where
T: BoundedBuf<Buf = FixedBuf>,
{
let orig_bounds = buf.bounds();
let (res, buf) = self.write_fixed_all_at_slice(buf.slice_full(), pos).await;
(res, T::from_buf_bounds(buf, orig_bounds))
}
async fn write_fixed_all_at_slice(
&self,
mut buf: Slice<FixedBuf>,
mut pos: u64,
) -> crate::BufResult<(), FixedBuf> {
if pos.checked_add(buf.bytes_init() as u64).is_none() {
return (
Err(io::Error::new(
io::ErrorKind::InvalidInput,
"buffer too large for file",
)),
buf.into_inner(),
);
}
while buf.bytes_init() != 0 {
let (res, slice) = self.write_fixed_at(buf, pos).await;
match res {
Ok(0) => {
return (
Err(io::Error::new(
io::ErrorKind::WriteZero,
"failed to write whole buffer",
)),
slice.into_inner(),
)
}
Ok(n) => {
pos += n as u64;
buf = slice.slice(n..);
}
// No match on an EINTR error is performed because this
// crate's design ensures we are not calling the 'wait' option
// in the ENTER syscall. Only an Enter with 'wait' can generate
// an EINTR according to the io_uring man pages.
Err(e) => return (Err(e), slice.into_inner()),
};
}
(Ok(()), buf.into_inner())
}
/// Attempts to sync all OS-internal metadata to disk.
///
/// This function will attempt to ensure that all in-memory data reaches the
/// filesystem before completing.
///
/// This can be used to handle errors that would otherwise only be caught
/// when the `File` is closed. Dropping a file will ignore errors in
/// synchronizing this in-memory data.
///
/// # Examples
///
/// ```no_run
/// use tokio_uring::fs::File;
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// tokio_uring::start(async {
/// let f = File::create("foo.txt").await?;
/// let (res, buf) = f.write_at(&b"Hello, world!"[..], 0).submit().await;
/// let n = res?;
///
/// f.sync_all().await?;
///
/// // Close the file
/// f.close().await?;
/// Ok(())
/// })
/// }
/// ```
pub async fn sync_all(&self) -> io::Result<()> {
Op::fsync(&self.fd)?.await
}
/// Attempts to sync file data to disk.
///
/// This method is similar to [`sync_all`], except that it may not
/// synchronize file metadata to the filesystem.
///
/// This is intended for use cases that must synchronize content, but don't
/// need the metadata on disk. The goal of this method is to reduce disk
/// operations.
///
/// Note that some platforms may simply implement this in terms of
/// [`sync_all`].
///
/// [`sync_all`]: File::sync_all
///
/// # Examples
///
/// ```no_run
/// use tokio_uring::fs::File;
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// tokio_uring::start(async {
/// let f = File::create("foo.txt").await?;
/// let (res, buf) = f.write_at(&b"Hello, world!"[..], 0).submit().await;
/// let n = res?;
///
/// f.sync_data().await?;
///
/// // Close the file
/// f.close().await?;
/// Ok(())
/// })
/// }
/// ```
pub async fn sync_data(&self) -> io::Result<()> {
Op::datasync(&self.fd)?.await
}
/// Manipulate the allocated disk space of the file.
///
/// The manipulated range starts at the `offset` and continues for `len` bytes.
///
/// The specific manipulation to the allocated disk space are specified by
/// the `flags`, to understand what are the possible values here check
/// the `fallocate(2)` man page.
///
/// # Examples
///
/// ```no_run
/// use tokio_uring::fs::File;
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// tokio_uring::start(async {
/// let f = File::create("foo.txt").await?;
///
/// // Allocate a 1024 byte file setting all the bytes to zero
/// f.fallocate(0, 1024, libc::FALLOC_FL_ZERO_RANGE).await?;
///
/// // Close the file
/// f.close().await?;
/// Ok(())
/// })
/// }
pub async fn fallocate(&self, offset: u64, len: u64, flags: i32) -> io::Result<()> {
Op::fallocate(&self.fd, offset, len, flags)?.await
}
/// Closes the file using the uring asynchronous close operation and returns the possible error
/// as described in the close(2) man page.
///
/// The programmer has the choice of calling this asynchronous close and waiting for the result
/// or letting the library close the file automatically and simply letting the file go out of
/// scope and having the library close the file descriptor automatically and synchronously.
///
/// Calling this asynchronous close is to be preferred because it returns the close result
/// which as the man page points out, should not be ignored. This asynchronous close also
/// avoids the synchronous close system call and may result in better throughput as the thread
/// is not blocked during the close.
///
/// # Examples
///
/// ```no_run
/// use tokio_uring::fs::File;
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// tokio_uring::start(async {
/// // Open the file
/// let f = File::open("foo.txt").await?;
/// // Close the file
/// f.close().await?;
///
/// Ok(())
/// })
/// }
/// ```
pub async fn close(mut self) -> io::Result<()> {
self.fd.close().await
}
}
impl FromRawFd for File {
unsafe fn from_raw_fd(fd: RawFd) -> Self {
File::from_shared_fd(SharedFd::new(fd))
}
}
impl AsRawFd for File {
fn as_raw_fd(&self) -> RawFd {
self.fd.raw_fd()
}
}
impl fmt::Debug for File {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("File")
.field("fd", &self.fd.raw_fd())
.finish()
}
}
/// Removes a File
///
/// This function will return an error in the following situations, but is not
/// limited to just these cases:
///
/// * `path` doesn't exist.
/// * [`io::ErrorKind`] would be set to `NotFound`
/// * The user lacks permissions to modify/remove the file at the provided `path`.
/// * [`io::ErrorKind`] would be set to `PermissionDenied`
///
/// # Examples
///
/// ```no_run
/// use tokio_uring::fs::remove_file;
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// tokio_uring::start(async {
/// remove_file("/some/file.txt").await?;
/// Ok::<(), std::io::Error>(())
/// })?;
/// Ok(())
/// }
/// ```
pub async fn remove_file<P: AsRef<Path>>(path: P) -> io::Result<()> {
Op::unlink_file(path.as_ref())?.await
}
/// Renames a file or directory to a new name, replacing the original file if
/// `to` already exists.
///
/// #Errors
///
/// * `path` doesn't exist.
/// * [`io::ErrorKind`] would be set to `NotFound`
/// * The user lacks permissions to modify/remove the file at the provided `path`.
/// * [`io::ErrorKind`] would be set to `PermissionDenied`
/// * The new name/path is on a different mount point.
/// * [`io::ErrorKind`] would be set to `CrossesDevices`
///
/// # Example
///
/// ```no_run
/// use tokio_uring::fs::rename;
///
/// fn main() -> Result<(), Box<dyn std::error::Error>> {
/// tokio_uring::start(async {
/// rename("a.txt", "b.txt").await?; // Rename a.txt to b.txt
/// Ok::<(), std::io::Error>(())
/// })?;
/// Ok(())
/// }
/// ```
pub async fn rename(from: impl AsRef<Path>, to: impl AsRef<Path>) -> io::Result<()> {
Op::rename_at(from.as_ref(), to.as_ref(), 0)?.await
}