diff --git a/integrations/cloud_filter/README.md b/integrations/cloud_filter/README.md index 175349791ac4..67a3c2e706a9 100644 --- a/integrations/cloud_filter/README.md +++ b/integrations/cloud_filter/README.md @@ -2,17 +2,17 @@ [![Build Status]][actions] [![Latest Version]][crates.io] [![Crate Downloads]][crates.io] [![chat]][discord] -[build status]: https://img.shields.io/github/actions/workflow/status/apache/opendal/test_behavior_integration_cloudfilter.yml?branch=main +[build status]: https://img.shields.io/github/actions/workflow/status/apache/opendal/test_behavior_integration_cloud_filter.yml?branch=main [actions]: https://github.com/apache/opendal/actions?query=branch%3Amain -[latest version]: https://img.shields.io/crates/v/cloudfilter_opendal.svg -[crates.io]: https://crates.io/crates/cloudfilter_opendal -[crate downloads]: https://img.shields.io/crates/d/cloudfilter_opendal.svg +[latest version]: https://img.shields.io/crates/v/cloud_filter_opendal.svg +[crates.io]: https://crates.io/crates/cloud_filter_opendal +[crate downloads]: https://img.shields.io/crates/d/cloud_filter_opendal.svg [chat]: https://img.shields.io/discord/1081052318650339399 [discord]: https://opendal.apache.org/discord -`cloudfilter_opendal` integrates OpenDAL with [cloud sync engines](https://learn.microsoft.com/en-us/windows/win32/cfapi/build-a-cloud-file-sync-engine). It provides a way to access various cloud storage on Windows. +`cloud_filter_opendal` integrates OpenDAL with [cloud sync engines](https://learn.microsoft.com/en-us/windows/win32/cfapi/build-a-cloud-file-sync-engine). It provides a way to access various cloud storage on Windows. -Note that `cloudfilter_opendal` is a read-only service, and it is not recommended to use it in production. +Note that `cloud_filter_opendal` is a read-only service, and it is not recommended to use it in production. ## Example @@ -43,7 +43,7 @@ async fn main() -> Result<()> { let client_path = std::env::var("CLIENT_PATH").expect("$CLIENT_PATH is set"); // Create a sync root id - let sync_root_id = SyncRootIdBuilder::new("cloudfilter_opendal") + let sync_root_id = SyncRootIdBuilder::new("cloud_filter_opendal") .user_security_id(SecurityId::current_user()?) .build(); @@ -63,7 +63,7 @@ async fn main() -> Result<()> { let handle = Handle::current(); let connection = Session::new().connect_async( &client_path, - cloudfilter_opendal::CloudFilter::new(op, client_path.clone().into()), + cloud_filter_opendal::CloudFilter::new(op, client_path.clone().into()), move |f| handle.block_on(f), )?; diff --git a/integrations/cloud_filter/examples/readonly.rs b/integrations/cloud_filter/examples/readonly.rs index 2859023ce2bd..56bcbc5d12d6 100644 --- a/integrations/cloud_filter/examples/readonly.rs +++ b/integrations/cloud_filter/examples/readonly.rs @@ -6,7 +6,7 @@ use cloud_filter::root::{ use opendal::{services, Operator}; use tokio::{runtime::Handle, signal}; -const PROVIDER_NAME: &str = "ro-cloudfilter"; +const PROVIDER_NAME: &str = "ro-cloud_filter"; const DISPLAY_NAME: &str = "Read Only Cloud Filter"; #[tokio::main] @@ -45,7 +45,7 @@ async fn main() { let connection = Session::new() .connect_async( &client_path, - cloudfilter_opendal::CloudFilter::new(op, client_path.clone().into()), + cloud_filter_opendal::CloudFilter::new(op, client_path.clone().into()), move |f| handle.block_on(f), ) .expect("create session"); diff --git a/integrations/cloud_filter/src/lib.rs b/integrations/cloud_filter/src/lib.rs index e2170a02f488..eb5518b6efad 100644 --- a/integrations/cloud_filter/src/lib.rs +++ b/integrations/cloud_filter/src/lib.rs @@ -15,10 +15,10 @@ // specific language governing permissions and limitations // under the License. -//! `cloudfilter_opendal` integrates OpenDAL with [cloud sync engines](https://learn.microsoft.com/en-us/windows/win32/cfapi/build-a-cloud-file-sync-engine). +//! `cloud_filter_opendal` integrates OpenDAL with [cloud sync engines](https://learn.microsoft.com/en-us/windows/win32/cfapi/build-a-cloud-file-sync-engine). //! It provides a way to access various cloud storage on Windows. //! -//! Note that `cloudfilter_opendal` is a read-only service, and it is not recommended to use it in production. +//! Note that `cloud_filter_opendal` is a read-only service, and it is not recommended to use it in production. //! //! # Example //! @@ -49,7 +49,7 @@ //! let client_path = std::env::var("CLIENT_PATH").expect("$CLIENT_PATH is set"); //! //! // Create a sync root id -//! let sync_root_id = SyncRootIdBuilder::new("cloudfilter_opendal") +//! let sync_root_id = SyncRootIdBuilder::new("cloud_filter_opendal") //! .user_security_id(SecurityId::current_user()?) //! .build(); //! @@ -69,7 +69,7 @@ //! let handle = Handle::current(); //! let connection = Session::new().connect_async( //! &client_path, -//! cloudfilter_opendal::CloudFilter::new(op, client_path.clone().into()), +//! cloud_filter_opendal::CloudFilter::new(op, client_path.clone().into()), //! move |f| handle.block_on(f), //! )?; //! diff --git a/integrations/cloud_filter/tests/behavior/README.md b/integrations/cloud_filter/tests/behavior/README.md index d6019d6b6596..f6828102f88a 100644 --- a/integrations/cloud_filter/tests/behavior/README.md +++ b/integrations/cloud_filter/tests/behavior/README.md @@ -2,11 +2,11 @@ Behavior tests are used to make sure every service works correctly. -`cloudfilter_opendal` is readonly currently, so we assume `fixtures/data` is the root of the test data. +`cloud_filter_opendal` is readonly currently, so we assume `fixtures/data` is the root of the test data. ## Run ```pwsh -cd .\integrations\cloudfilter +cd .\integrations\cloud_filter $env:OPENDAL_TEST='fs'; $env:OPENDAL_FS_ROOT='../../fixtures/data'; $env:OPENDAL_DISABLE_RANDOM_ROOT='true'; cargo test --test behavior ``` diff --git a/integrations/cloud_filter/tests/behavior/main.rs b/integrations/cloud_filter/tests/behavior/main.rs index 4a860501b750..0b2cd371731e 100644 --- a/integrations/cloud_filter/tests/behavior/main.rs +++ b/integrations/cloud_filter/tests/behavior/main.rs @@ -34,12 +34,12 @@ use cloud_filter::{ SyncRootIdBuilder, SyncRootInfo, }, }; -use cloudfilter_opendal::CloudFilter; +use cloud_filter_opendal::CloudFilter; use libtest_mimic::{Arguments, Trial}; use opendal::{raw::tests, Operator}; use tokio::runtime::Handle; -const PROVIDER_NAME: &str = "ro-cloudfilter"; +const PROVIDER_NAME: &str = "ro-cloud_filter"; const DISPLAY_NAME: &str = "Test Cloud Filter"; const ROOT_PATH: &str = "C:\\sync_root";