Skip to content

Latest commit

 

History

History
191 lines (138 loc) · 9.18 KB

CHANGELOG.md

File metadata and controls

191 lines (138 loc) · 9.18 KB
Raw

Changelog

Unreleased

[2.1.0] - 2024-12-19

Changed

  • bindgen has been updated from 0.59 to 0.68.

Fixed

  • Various broken intra-doc links have been fixed.
  • The doc-example for str2zwr has been extended to also work in non-UTF8 mode.
  • The build script for YDBRust is now compatible with bindgen 0.63+.

[2.0.0] - 2022-03-01

Added

  • Added [Key::last_mut], which is a shorter and non-panicking version of &mut key[key.len() - 1].

Changed

  • The simple_api is now private. We recommend using the context_api instead.

    Most functions in the simple_api had one of two forms: either free functions, or associated functions of Key. For free functions, you can replace your calls with a call to Context:

    // previous code
let serialized = yottadb::simple_api::str2zwr_st(TpToken::default(), Vec::new(), "💖".as_bytes());
// new code
let ctx = yottadb::Context::new();
let serialized = ctx.str2zwr("💖".as_bytes());

    For functions on Key, you can use KeyContext instead:

    // previous code
let key = yottadb::simple_api::Key::variable("^hello");
let value = key.get_st(TpToken::default(), Vec::new())?;
// new code
let ctx = yottadb::Context::new();
let key = yottadb::KeyContext::variable(&ctx, "^hello");
let value = key.get()?;

  • The tptoken field of YDBError is now private. This prevents infinite hangs, aborts, or other bugs when calling error.to_string() on an error with an invalid tptoken. As a side effect, YDBError cannot be constructed outside of the yottadb crate.

  • The context_api module is now hidden from the documentation and its items are re-exported at the crate root; we recommend using the top-level items instead. However, it still remains public to make migration to 2.0 easier.

  • KeyContext::next_sub and prev_sub now return a Vec<u8> buffer instead of a full KeyContext. To replicate the old behavior, you can use this snippet:

let mut new_key = key.clone();
new_key.next_sub_self()?;
  • Context::zwr2str no longer requires an out_buffer parameter.

[1.2.0] - 2021-02-07

Fixed

  • The following functions can no longer cause memory corruption when resizing buffers (!118):

    See the test case for details about exactly how this could break before.

  • impl Error for YDBError no longer returns itself in fn cause(). This avoids infinite loops when iterating over the source of an error. !115

  • Returning a YDBError from inside a transaction no longer discards the error buffer. Previously, the error buffer would always be shown as empty even if an error occurred. !121

  • The test suite is now thread-safe. Note that this is only changed the test suite, the main YDBRust API has always been thread-safe. !112

Added

  • yottadb no longer requires compiling bindgen from source (when passed --no-default-features). See !101 for details.
  • KeyContext now implements AddAssign as a shortcut for increment(). !113
  • u64 now implements From<Tptoken>. Previously, u64::from(tptoken) would be a compile error even though let u: u64 = tptoken.into() worked correctly. !122
  • Various Debug implementations are more readable. !111

Changed

  • The minimum supported Rust version (MSRV) has been increased to 1.40. !110
  • Errors for transactions are now required to implement Send and Sync. !99
  • Various dependencies have been updated. !110

[1.1.0] - 2020-09-01

Fixed

  • ci_t! and ci_t_p! can no longer loop forever if passed an output buffer with insufficient capacity (!98)
  • Several broken links in the documentation have been fixed (!95)

[1.0.0] - 2020-08-17

Added

  • Types shared between the context_api and simple_api, such as YDBError, are now re-exported at the top level (!40)

  • The following C Simple API functions are now exposed:

    • ydb_delete_excl_st (!46)
    • ydb_lock_{incr,decr}_st (!48)
    • ydb_str2zwr and ydb_zwr2_str (!51)
    • ydb_lock_st (!55)
    • ydb_eintr_handler_t (!86)
    • Utility functions (!68)
      • ydb_message
      • ydb_ci_tab_open_t
      • ydb_ci_tab_switch_t
      • ydb_ci_t
      • ydb_cip_t
      • ydb_exit

  • Added release_st (!68) printing the version of the Rust wrapper

  • Added compatibility with Rust 1.34 (!75)

  • tp_st now allows rolling back or restarting a transaction (!65)

  • ParseError now implements std::error::Error (!71)

  • Added many more tests and documention:

Changed

  • TpToken is now its own type instead of a u64, to prevent passing in an invalid tptoken (!76).
  • tp_st now takes a slice of strings instead of a slice of Vec (!64)
  • bindgen is now built in debug mode even when YDBRust is built in release mode, greatly improving compile times (!81)
  • The buffers in the context_api are no longer pre-allocated, greatly reducing memory usage (!82)
  • bindgen has been updated to 0.54 (!91)

Fixed

  • Many crashes, panics, and segfaults have been fixed. See variously

  • incr_st no longer increments twice when passed an out_buffer that is too small (!44)

[0.3.0] - 2020-02-03

Removed

  • Removed impl DerefMut<Target = Vec<u8>> for Key in favor of more specific methods and impls

Changed

  • The add_st(), set_st(), and delete_st() functions now take &Key instead of &mut Key, making the borrow semantics easier to work with. See #12 for more details.
  • Updated bindgen to 0.52, removing several unnecessary dependencies

[0.2.0] - 2020-01-27

Fixed

Added

  • KeyContext::get_and_parse() convenience function

Changed

  • Use truncate() or resize() instead of set_len() in documentation and examples