Documentation fixes and lints

Author: creativcoder

.github/workflows/ci.yml

@@ -1,3 +1,5 @@
+name: ci
+
 on: [push, pull_request]
 
 jobs:

README.md

@@ -1,8 +1,8 @@
 <div align="center">
   <img alt="avrow" width="250" src="assets/avrow_logo.png" />
 
-[![github actions](https://github.com/creativcoder/avrow/workflows/Rust/badge.svg)](https://github.com/creativcoder/avrow/actions)
-[![crates](https://img.shields.io/crates/v/avrow.svg)](https://crates.io/crates/io-uring)
+[![Actions Status](https://github.com/creativcoder/avrow/workflows/ci/badge.svg)](https://github.com/creativcoder/avrow/actions)
+[![crates](https://img.shields.io/crates/v/avrow.svg)](https://crates.io/crates/avrow)
 [![docs.rs](https://docs.rs/avrow/badge.svg)](https://docs.rs/avrow/)
 [![license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/creativcoder/avrow/blob/master/LICENSE-MIT)
 [![license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/creativcoder/avrow/blob/master/LICENSE-APACHE)
@@ -81,7 +81,7 @@ Add avrow as a dependency to `Cargo.toml`:
 
 ```toml
 [dependencies]
-avrow = "0.1"
+avrow = "0.1.0"
 ```
 
 ## Examples:
@@ -112,7 +112,7 @@ fn main() -> Result<(), Error> {
 }
 
 ```
-For simple and native Rust types, avrow provides a `From` impl for Avro value types. For compound or user defined types (structs, enums), one can use the `serialize` method which relies on serde. Alternatively, one can construct `avrow::Value` instances which is a more verbose way to write avro values and should be a last resort.
+For simple and native Rust types, avrow provides a `From` impl to convert to Avro value types. For compound or user defined types (structs or enums), one can use the `serialize` method which relies on serde. Alternatively, one can construct `avrow::Value` instances which is a more verbose way to write avro values and should be a last resort.
 
 ### Reading avro data
 

benches/write.rs

@@ -12,51 +12,54 @@
 //! ### A hello world example of reading and writing avro data files
 
 //!```rust
-//!use avrow::{Reader, Schema, Writer, from_value};
-//!use std::str::FromStr;
-//!use std::error::Error;
+//! use avrow::{Reader, Schema, Writer, from_value};
+//! use std::str::FromStr;
+//! use anyhow::Error;
 //!
-//!use std::io::Cursor;
+//! fn main() -> Result<(), Error> {
+//!     // Writing data
 //!
-//!fn main() -> Result<(), Box<dyn Error>> {
-//!    // Writing data
+//!     // Create a schema
+//!     let schema = Schema::from_str(r##""null""##)?;
+//!     // Create writer using schema and provide a buffer to write to
+//!     let mut writer = Writer::new(&schema, vec![])?;
+//!     // Write data using write
+//!     writer.write(())?;
+//!     // or serialize
+//!     writer.serialize(())?;
+//!     // retrieve the underlying buffer using the into_inner method.
+//!     let buf = writer.into_inner()?;
 //!
-//!    // Create a schema
-//!    let schema = Schema::from_str(r##""null""##)?;
-//!    // Create writer using schema and provide a buffer to write to
-//!    let mut writer = Writer::new(&schema, vec![])?;
-//!    // Write the data using append
-//!    writer.serialize(())?;
-//!    // or serialize
-//!    writer.serialize(())?;
-//!    // retrieve the underlying buffer using the into_inner method.
-//!    let buf = writer.into_inner()?;
+//!     // Reading data
 //!
-//!    // Reading data
-//!
-//!    // Create Reader by providing a Read wrapped version of `buf`
-//!    let reader = Reader::new(buf.as_slice())?;
-//!    // Use iterator for reading data in an idiomatic manner.
-//!    for i in reader {
-//!        // reading values can fail due to decoding errors, so the return value of iterator is a Option<Result<Value>>
-//!        // it allows one to examine the failure reason on the underlying avro reader.
-//!        dbg!(&i);
-//!        // This value can be converted to a native Rust type using from_value method from the serde impl.
-//!        let _: () = from_value(&i)?;
-//!    }
-//!
-//!    Ok(())
-//!}
+//!     // Create Reader by providing a Read wrapped version of `buf`
+//!     let reader = Reader::new(buf.as_slice())?;
+//!     // Use iterator for reading data in an idiomatic manner.
+//!     for i in reader {
+//!         // reading values can fail due to decoding errors, so the return value of iterator is a Option<Result<Value>>
+//!         // it allows one to examine the failure reason on the underlying avro reader.
+//!         dbg!(&i);
+//!         // This value can be converted to a native Rust type using from_value method from the serde impl.
+//!         let _: () = from_value(&i)?;
+//!     }
 //!
+//!     Ok(())
+//! }
+
 //!```
 
 // TODO update logo
-#![doc(html_favicon_url = "")]
-#![doc(html_logo_url = "assets/avrow_logo.png")]
+#![doc(
+    html_favicon_url = "https://raw.githubusercontent.com/creativcoder/avrow/main/assets/avrow_logo.png"
+)]
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/creativcoder/avrow/main/assets/avrow_logo.png"
+)]
 #![deny(missing_docs)]
 #![recursion_limit = "1024"]
 #![deny(unused_must_use)]
-// #![deny(warnings)]
+#![deny(rust_2018_idioms)]
+#![deny(warnings)]
 
 mod codec;
 pub mod config;

src/lib.rs

@@ -28,11 +28,6 @@ use value::{FieldValue, Record, Value};
 pub struct Reader<R> {
     source: R,
     header: Header,
-    // TODO when reading data call resolve schema https://avro.apache.org/docs/1.8.2/spec.html#Schema+Resolution
-    // This is the schema after it has been resolved using both reader and writer schema
-    // NOTE: This is a partially resolved schema
-    // schema: Option<ResolvedSchema>,
-    // TODO this is for experimental purposes, ideally we can just use references
     reader_schema: Option<Schema>,
     block_buffer: Cursor<Vec<u8>>,
     entries_in_block: u64,

src/reader.rs

@@ -188,7 +188,7 @@ impl Name {
 }
 
 impl Display for Name {
-    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         if let Some(ref namespace) = self.namespace {
             write!(f, "{}.{}", namespace, self.name)
         } else {