// Copyright 2022 Datafuse Labs.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! OpenDAL is the Open Data Access Layer that connect the whole world together.
//!
//! # Supported Services
//!
//! | Services | Description |
//! | -------- | ----------- |
//! | [azblob][crate::services::azblob] | Azure Storage Blob services. |
//! | [fs][crate::services::fs] | POSIX alike file system. |
//! | [ftp][crate::services::ftp] | FTP and FTPS support. |
//! | [gcs][crate::services::gcs] | Google Cloud Storage service. |
//! | [hdfs][crate::services::hdfs] | Hadoop Distributed File System(HDFS). |
//! | [http][crate::services::http] | HTTP read-only backend. |
//! | [ipfs][crate::services::ipfs] | IPFS HTTP Gateway support. |
//! | [ipmfs][crate::services::ipmfs] | IPFS Mutable File System support. |
//! | [memory][crate::services::memory] | In memory backend support. |
//! | [obs][crate::services::obs] | Huawei Cloud OBS service. |
//! | [s3][crate::services::s3] | AWS S3 alike services. |
//!
//! # Optional features
//!
//! ## Layers
//!
//! - `layers-all`: Enable all layers support.
//! - `layers-retry`: Enable operator retry support.
//! - `layers-metrics`: Enable operator metrics support.
//! - `layers-tracing`: Enable operator tracing support.
//!
//! ## Services
//!
//! - `services-ftp`: Enable ftp service support.
//! - `services-hdfs`: Enable hdfs service support.
//! - `services-ipfs`: Enable ipfs service support.
//!
//! ## Dependencies features
//!
//! - `compress`: Enable object decompress read support.
//! - `rustls`: Use rustls instead openssl for https connection
//! - `serde`: Implement serde::{Serialize,Deserialize} for ObjectMetadata.
//!
//! # Example
//!
//! ```no_run
//! use anyhow::Result;
//! use futures::StreamExt;
//! use futures::TryStreamExt;
//! use opendal::Object;
//! use opendal::ObjectEntry;
//! use opendal::ObjectMetadata;
//! use opendal::ObjectMode;
//! use opendal::ObjectStreamer;
//! use opendal::Operator;
//! use opendal::Scheme;
//!
//! #[tokio::main]
//! async fn main() -> Result<()> {
//!     // Init Operator
//!     let op = Operator::from_env(Scheme::Fs)?;
//!
//!     // Create object handler.
//!     let o = op.object("test_file");
//!
//!     // Write data info object;
//!     o.write("Hello, World!").await?;
//!
//!     // Read data from object;
//!     let bs = o.read().await?;
//!
//!     // Read range from object;
//!     let bs = o.range_read(1..=11).await?;
//!
//!     // Get object's path
//!     let name = o.name();
//!     let path = o.path();
//!
//!     // Fetch more meta about object.
//!     let meta = o.metadata().await?;
//!     let mode = meta.mode();
//!     let length = meta.content_length();
//!     let content_md5 = meta.content_md5();
//!     let etag = meta.etag();
//!
//!     // Delete object.
//!     o.delete().await?;
//!
//!     // List dir object.
//!     let o = op.object("test_dir/");
//!     let mut ds = o.list().await?;
//!     while let Some(entry) = ds.try_next().await? {
//!         let path = entry.path();
//!         let mode = entry.mode();
//!     }
//!
//!     Ok(())
//! }
//! ```

// Make sure all our public APIs have docs.
#![warn(missing_docs)]
// Deny unused qualifications.
#![deny(unused_qualifications)]
// Add options below to allow/deny Clippy lints.

// Private module with public types, they will be accessed via `opendal::Xxxx`
mod accessor;
pub use accessor::Accessor;
pub use accessor::AccessorCapability;
pub use accessor::AccessorMetadata;

mod io;
pub use io::BlockingBytesRead;
pub use io::BlockingBytesReader;
pub use io::BytesRead;
pub use io::BytesReader;
pub use io::BytesSink;
pub use io::BytesStream;
pub use io::BytesWrite;
pub use io::BytesWriter;

mod operator;
pub use operator::BatchOperator;
pub use operator::Operator;

mod object;
pub use object::Object;
pub use object::ObjectEntry;
#[deprecated(since = "0.18.0", note = "Please use ObjectEntry instead")]
pub use object::ObjectEntry as DirEntry;
pub use object::ObjectIterate;
#[deprecated(since = "0.18.0", note = "Please use ObjectIterate instead")]
pub use object::ObjectIterate as DirIterate;
pub use object::ObjectIterator;
#[deprecated(since = "0.18.0", note = "Please use ObjectIterator instead")]
pub use object::ObjectIterator as DirIterator;
pub use object::ObjectMetadata;
pub use object::ObjectMode;
pub use object::ObjectStream;
#[deprecated(since = "0.18.0", note = "Please use ObjectStream instead")]
pub use object::ObjectStream as DirStream;
pub use object::ObjectStreamer;
#[deprecated(since = "0.18.0", note = "Please use ObjectStreamer instead")]
pub use object::ObjectStreamer as DirStreamer;

mod multipart;
pub use multipart::ObjectMultipart;
pub use multipart::ObjectPart;

mod scheme;
pub use scheme::Scheme;

// Public modules, they will be accessed via `opendal::io_util::Xxxx`
pub mod http_util;
pub mod io_util;
pub mod layers;
pub use layers::Layer;
pub mod ops;
pub mod services;

// Private modules, internal use only.
//
// Please don't export any type from this module.
mod error;
mod path;

#[cfg(test)]
mod tests {
    use std::mem::size_of;

    use super::*;

    /// This is not a real test case.
    ///
    /// We assert our public structs here to make sure we don't introduce
    /// unexpected struct/enum size change.
    #[test]
    fn assert_size() {
        assert_eq!(80, size_of::<AccessorMetadata>());
        assert_eq!(16, size_of::<Operator>());
        assert_eq!(16, size_of::<BatchOperator>());
        assert_eq!(56, size_of::<ObjectEntry>());
        assert_eq!(40, size_of::<Object>());
        assert_eq!(88, size_of::<ObjectMetadata>());
        assert_eq!(1, size_of::<ObjectMode>());
        assert_eq!(64, size_of::<ObjectMultipart>());
        assert_eq!(32, size_of::<ObjectPart>());
        assert_eq!(24, size_of::<Scheme>());
    }
}