Skip to content

Commit

Permalink
deploy: 53166e4
Browse files Browse the repository at this point in the history
  • Loading branch information
Mallets committed Sep 12, 2024
1 parent bb37356 commit 61b0aeb
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 21 deletions.
4 changes: 2 additions & 2 deletions docs/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,12 @@ This major release comes with several API changes, quality of life improvements
We now have a more stable API and intend to keep backward compatibility in future Zenoh revisions.
This guide is here to ease the transition to Zenoh 1.0.0 for our users!
Value is gone, long live ZBytes We have replaced Value with ZBytes and Encoding.</description></item><item><title>Rust</title><link>/docs/migration_1.0/rust/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/migration_1.0/rust/</guid><description>Module reorganization We reorganized the module tree, so import paths are not the same as before. The main difference is that everything should be imported via the root path zenoh::. Here are some examples, but you can look into zenoh/src/lib.rs for the complete list of changes.
// common use use zenoh::config::*; use zenoh::{Config, Error, Result}; // key_expr &amp;amp; selector use zenoh::key_expr::{ format::{kedefine, keformat}, keyexpr, KeyExpr, OwnedKeyExpr, }; // session use zenoh::session::{init, open, EntityId, Session, SessionInfo}; // publisher &amp;amp; subscriber use zenoh::pubsub::{Publisher, Reliability, Subscriber}; // query &amp;amp; queryable &amp;amp; selectors use zenoh::query::{ ConsolidationMode, Parameters, Query, QueryConsolidation, QueryTarget, Queryable, Reply, Selector, }; // ZBytes &amp;amp; encoding use zenoh::bytes::{ZBytes, Encoding}; // sample use zenoh::sample::{Locality, Sample}; // quality of service use zenoh::qos::{CongestionControl, Priority, QoSBuilderTrait}; The changes to sync and async In the previous version of Zenoh, we needed to use different module paths for the synchronous and asynchronous API.</description></item><item><title>C++</title><link>/docs/migration_1.0/c++/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/migration_1.0/c++/</guid><description>Zenoh 1.0.0 brings a number of changes to the API, with a concentrated effort to bring the C++ API to more closely resemble the Rust API in usage.
// common use use zenoh::config::*; use zenoh::{Config, Error, Result}; // key_expr &amp;amp; selector use zenoh::key_expr::{ format::{kedefine, keformat}, keyexpr, KeyExpr, OwnedKeyExpr, }; // session use zenoh::session::{init, open, EntityId, Session, SessionInfo}; // publisher &amp;amp; subscriber use zenoh::pubsub::{Publisher, Reliability, Subscriber}; // query &amp;amp; queryable &amp;amp; selectors use zenoh::query::{ ConsolidationMode, Parameters, Query, QueryConsolidation, QueryTarget, Queryable, Reply, Selector, }; // ZBytes &amp;amp; encoding use zenoh::bytes::{ZBytes, Encoding}; // sample use zenoh::sample::{Locality, Sample}; // quality of service use zenoh::qos::{CongestionControl, Priority, QoSBuilderTrait}; Removal of the sync and async preludes Zenoh preludes has been deprecated and are no more used in the API.</description></item><item><title>C++</title><link>/docs/migration_1.0/c++/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/migration_1.0/c++/</guid><description>Zenoh 1.0.0 brings a number of changes to the API, with a concentrated effort to bring the C++ API to more closely resemble the Rust API in usage.
The improvements we bring in this update include:
A simpler organization of the Zenoh classes, abstracting away the notion of View and Closure. Improved and more flexible Error Handling through error codes and exceptions. Support for serialization of common types like strings, numbers, vectors through Codecs.</description></item><item><title>C / Pico</title><link>/docs/migration_1.0/c_pico/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/migration_1.0/c_pico/</guid><description>General API changes We have reworked the type naming to clarify how types should be interacted with.
Owned types Owned types are allocated by the user and it is their responsibility to drop them using z_drop (or z_close for sessions).
Previously, we were returning Zenoh structures by value. In Zenoh 1.0.0, a reference to memory must be provided. This allows initializing user allocated structures and frees return value for error codes.</description></item><item><title>Python</title><link>/docs/migration_1.0/python/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/migration_1.0/python/</guid><description>Highlights The library has been fully rewritten to use only Rust. It should make no difference for users, except for a significant performance improvement.
The API has also been reworked to feel more pythonic, using notably context managers.
Context managers and background execution You should close the zenoh session after use and the recommended way is through context manager:
Context managers and background callbacks You should close the zenoh session after use and the recommended way is through context manager:
import zenoh with zenoh.open(zenoh.Config()) as session: # `session.close()` will be called at the end of the block Session-managed objects like subscribers or queryables can also be managed using context managers:</description></item><item><title>Java</title><link>/docs/migration_1.0/java/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/migration_1.0/java/</guid><description>The Java API is still a work in progress. This migration guide will be updated as soon as the new Zenoh-Java API is released!</description></item><item><title>Kotlin</title><link>/docs/migration_1.0/kotlin/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/docs/migration_1.0/kotlin/</guid><description>Kotlin API migration guide for 1.0.0 The API has been extensively modified with the following goals in mind:
Enhancing the API to be more idiomatic to Kotlin. Match the API rework done through the Rust Zenoh API. Abstracting users from the underlying native mechanisms Default arguments Throughout the 0.11.0 API we were exposing builders, however we decided to replace all of them with the more Kotlin-idiomatic way of the default arguments.</description></item></channel></rss>
Loading

0 comments on commit 61b0aeb

Please sign in to comment.