Pass complete args struct to create_history_stream #56

2022-08-09T07:36:09Z

glyph commented

2022-08-09 07:36:09 +00:00

Addresses #55

The relevant changes here are in src/api/history_stream.rs and examples/streams.rs.

Previously we were simply passing the ssb_id into create_history_stream(). This PR publically exports the CreateHistoryStreamIn type from kuska and renames it as CreateHistoryStream. create_history_stream() now expects a single argument in the form of CreateHistoryStream (this is similar to how SubsetQuery is passed to get_subset_stream()).

This change allows a library user to set additional options for the create_history_stream call, including the minimum sequence number and a limit on returned messages.

One question I have for @notplants: do you think CreateHistoryStream is consistent with the naming in the rest of golgi? I'm not entirely happy with it...perhaps HistoryStreamArgs is better?

Example usage:

let history_stream = sbot_client.create_history_stream(CreateHistoryStream::new(author.to_string())).await?;

// or with more options enabled

let args = CreateHistoryStream::new(author.to_string()).keys_values(true, true).after_seq(75).limit(10);
let history_stream = sbot_client.create_history_stream(args).await?;

Addresses https://git.coopcloud.tech/golgi-ssb/golgi/issues/55 The relevant changes here are in `src/api/history_stream.rs` and `examples/streams.rs`. Previously we were simply passing the `ssb_id` into `create_history_stream()`. This PR publically exports the [CreateHistoryStreamIn](https://github.com/Kuska-ssb/ssb/blob/master/src/api/dto/history_stream.rs) type from kuska and renames it as `CreateHistoryStream`. `create_history_stream()` now expects a single argument in the form of `CreateHistoryStream` (this is similar to how `SubsetQuery` is passed to `get_subset_stream()`). This change allows a library user to set additional options for the `create_history_stream` call, including the minimum sequence number and a limit on returned messages. One question I have for @notplants: do you think `CreateHistoryStream` is consistent with the naming in the rest of golgi? I'm not entirely happy with it...perhaps `HistoryStreamArgs` is better? ----- Example usage: ```rust let history_stream = sbot_client.create_history_stream(CreateHistoryStream::new(author.to_string())).await?; // or with more options enabled let args = CreateHistoryStream::new(author.to_string()).keys_values(true, true).after_seq(75).limit(10); let history_stream = sbot_client.create_history_stream(args).await?; ```

glyph added the enhancement label 2022-08-09 07:36:09 +00:00

glyph added 10 commits 2022-08-09 07:36:10 +00:00

basic names rpc support 2e1e9a79f1

merge main ab86d4fe0b

introduce names_get_signifier and names_get_image 31b432165e

remove unnecessary imports 3fe1a4bbea

add get_signifier method and call it from get_name 05e2540403

fix kuska dependency and bump version 821198a400

revert friends example code e16f567c19

pass CreateHistoryStream as arg 80e99deb6f

update create_history_stream example c556373a96

bump version 1335aeb544