staart

Crates.iostaart
lib.rsstaart
version0.7.2
sourcesrc
created_at2020-12-19 11:58:17.5103
updated_at2024-04-30 22:28:35.171194
descriptionA Rust implementation of a tail-like library and binary crate
homepagehttps://github.com/anthonyjmartinez/staart
repositoryhttps://github.com/anthonyjmartinez/staart.git
max_upload_size
id324552
size31,474
Anthony Martinez (anthonyjmartinez)

documentation

README

About

staart is tail-like implementation in Rust. The binary expects exactly one argument which is the file to be followed. Tailing of the file starts at the end of the file, and continues from there. If a file is rotated with a new file created with the same name the program will continue following the named file, and not the previous version. In the case of truncation, data are printed from the start of the file.

Binary

staart offers a Rust std-lib only binary crate capable of following a file. If the file is rotated, the new file will be followed. Following will start at the beginning should truncation be detected. Usage is simple:

staart <path/to/file.ext>

The full feature set of tail is not replicated here. staart will always start from the end of the file, and print all subsequently appearing data to stdout. If non-utf8 code points are found an error is printed to stderr.

If the path given to staart does not exist for three open attempts, the application exits with status code 1.

Library

staart can be used as a library exposing methods to the TailedFile struct it creates should there be a need to follow a file from directly within a more complicated application.

Documentation can be found here.

Windows Support

staart will at least run in a Windows environment as of v0.4.0, but the behavior is not identical to the Linux environment for reasons unknown to the developer. Contributions are welcome if someone wishes to fix this.

MacOS Support

staart will at least run in a MacOS environment as of v0.7.2.

MSRV

This crate makes use of format strings stabilized in Rust 1.58, as such this is the Minimum Supported Rust Version.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Copyright (C) 2020-2024 Anthony Martinez

Commit count: 31

cargo fmt