xref: /commonlibrary/rust/ylong_http/ylong_http_client/src/lib.rs

// Copyright (c) 2023 Huawei Device Co., Ltd.
// 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.

//! `ylong_http_client` provides a HTTP client that based on `ylong_http` crate.
//! You can use the client to send request to a server, and then get the
//! response.
//!
//! # Supported HTTP Version
//! - HTTP/1.1
//! - HTTP/2
// TODO: Need doc.

// ylong_http crate re-export.
#[cfg(any(feature = "ylong_base", feature = "tokio_base"))]
pub use ylong_http::body::{EmptyBody, ReusableReader, TextBody};
pub use ylong_http::headers::{
    Header, HeaderName, HeaderValue, HeaderValueIter, HeaderValueIterMut, Headers, HeadersIntoIter,
    HeadersIter, HeadersIterMut,
};
pub use ylong_http::request::method::Method;
pub use ylong_http::request::uri::{Scheme, Uri};
pub use ylong_http::request::{Request, RequestPart};
pub use ylong_http::response::status::StatusCode;
pub use ylong_http::response::ResponsePart;
pub use ylong_http::version::Version;

#[macro_use]
#[cfg(all(
    any(feature = "async", feature = "sync"),
    any(feature = "http1_1", feature = "http2"),
))]
mod error;

#[cfg(all(feature = "async", any(feature = "http1_1", feature = "http2")))]
pub mod async_impl;

#[cfg(all(feature = "sync", any(feature = "http1_1", feature = "http2")))]
pub mod sync_impl;

#[cfg(all(
    any(feature = "async", feature = "sync"),
    any(feature = "http1_1", feature = "http2"),
))]
pub(crate) mod util;

#[cfg(all(
    any(feature = "async", feature = "sync"),
    any(feature = "http1_1", feature = "http2"),
))]
pub use error::{ErrorKind, HttpClientError};
#[cfg(all(
    any(feature = "async", feature = "sync"),
    any(feature = "http1_1", feature = "http2"),
))]
pub use util::*;

// Runtime components import adapter.
#[cfg(any(feature = "tokio_base", feature = "ylong_base"))]
pub(crate) mod runtime {
    #[cfg(all(feature = "tokio_base", any(feature = "http2", feature = "http3")))]
    pub(crate) use tokio::{
        io::{split, ReadHalf, WriteHalf},
        spawn,
        sync::{
            mpsc::{
                channel as bounded_channel, error::SendError, unbounded_channel,
                Receiver as BoundedReceiver, Sender as BoundedSender, UnboundedReceiver,
                UnboundedSender,
            },
            Mutex as AsyncMutex, MutexGuard,
        },
    };
    #[cfg(all(feature = "tokio_base", feature = "async"))]
    pub(crate) use tokio::{
        io::{AsyncRead, AsyncReadExt, AsyncWrite, AsyncWriteExt, ReadBuf},
        net::TcpStream,
        task::{spawn_blocking, JoinHandle},
        time::{sleep, timeout, Sleep},
    };
    #[cfg(feature = "ylong_base")]
    pub(crate) use ylong_runtime::{
        io::{AsyncRead, AsyncReadExt, AsyncWrite, AsyncWriteExt, ReadBuf},
        net::TcpStream,
        spawn_blocking,
        task::JoinHandle,
        time::{sleep, timeout, Sleep},
    };
    // TODO add ReadHalf and WriteHalf
    #[cfg(all(feature = "ylong_base", any(feature = "http2", feature = "http3")))]
    pub(crate) use ylong_runtime::{
        spawn,
        sync::{
            error::SendError,
            mpsc::{
                bounded_channel, unbounded_channel, BoundedReceiver, BoundedSender,
                UnboundedReceiver, UnboundedSender,
            },
            Mutex as AsyncMutex, MutexGuard,
        },
    };

    #[cfg(all(feature = "ylong_base", feature = "http2"))]
    pub(crate) use crate::{split, Reader as ReadHalf, Writer as WriteHalf};
}