1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906
// This file was @generated by wasmcloud/weld-codegen 0.7.0.
// It was not intended for manual editing, but we did it anyway.
// namespace: org.wasmcloud.interface.blobstore
#[allow(unused_imports)]
use async_trait::async_trait;
#[allow(unused_imports)]
use serde::{Deserialize, Serialize};
#[allow(unused_imports)]
use std::{borrow::Borrow, borrow::Cow, io::Write, string::ToString};
#[allow(unused_imports)]
use wasmbus_rpc::{
cbor::*,
common::{
deserialize, message_format, serialize, Context, Message, MessageDispatch, MessageFormat,
SendOpts, Transport,
},
error::{RpcError, RpcResult},
Timestamp,
};
#[allow(dead_code)]
pub const SMITHY_VERSION: &str = "1.0";
/// A portion of a file. The `isLast` field indicates whether this chunk
/// is the last in a stream. The `offset` field indicates the 0-based offset
/// from the start of the file for this chunk.
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct Chunk {
#[serde(rename = "objectId")]
pub object_id: ObjectId,
#[serde(rename = "containerId")]
pub container_id: ContainerId,
/// bytes in this chunk
#[serde(with = "serde_bytes")]
#[serde(default)]
pub bytes: Vec<u8>,
/// The byte offset within the object for this chunk
#[serde(default)]
pub offset: u64,
/// true if this is the last chunk
#[serde(rename = "isLast")]
#[serde(default)]
pub is_last: bool,
}
/// Response from actor after receiving a download chunk.
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct ChunkResponse {
/// If set and `true`, the sender will stop sending chunks,
#[serde(rename = "cancelDownload")]
#[serde(default)]
pub cancel_download: bool,
}
/// Name of a container
pub type ContainerId = String;
/// list of container names
pub type ContainerIds = Vec<ContainerId>;
/// Metadata for a container.
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct ContainerMetadata {
/// Container name
#[serde(rename = "containerId")]
pub container_id: ContainerId,
/// Creation date, if available
#[serde(rename = "createdAt")]
#[serde(default, skip_serializing_if = "Option::is_none")]
pub created_at: Option<Timestamp>,
}
/// Combination of container id and object id
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct ContainerObject {
#[serde(rename = "containerId")]
pub container_id: ContainerId,
#[serde(rename = "objectId")]
pub object_id: ObjectId,
}
/// list of container metadata objects
pub type ContainersInfo = Vec<ContainerMetadata>;
/// Parameter to GetObject
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct GetObjectRequest {
/// object to download
#[serde(rename = "objectId")]
pub object_id: ObjectId,
/// object's container
#[serde(rename = "containerId")]
pub container_id: ContainerId,
/// Requested start of object to retrieve.
/// The first byte is at offset 0. Range values are inclusive.
/// If rangeStart is beyond the end of the file,
/// an empty chunk will be returned with isLast == true
#[serde(rename = "rangeStart")]
#[serde(default, skip_serializing_if = "Option::is_none")]
pub range_start: Option<u64>,
/// Requested end of object to retrieve. Defaults to the object's size.
/// It is not an error for rangeEnd to be greater than the object size.
/// Range values are inclusive.
#[serde(rename = "rangeEnd")]
#[serde(default, skip_serializing_if = "Option::is_none")]
pub range_end: Option<u64>,
}
/// Response to GetObject
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct GetObjectResponse {
/// indication whether the request was successful
#[serde(default)]
pub success: bool,
/// If success is false, this may contain an error
#[serde(default, skip_serializing_if = "Option::is_none")]
pub error: Option<String>,
/// The provider may begin the download by returning a first chunk
#[serde(rename = "initialChunk")]
#[serde(default, skip_serializing_if = "Option::is_none")]
pub initial_chunk: Option<Chunk>,
/// Length of the content. (for multi-part downloads, this may not
/// be the same as the length of the initial chunk)
#[serde(rename = "contentLength")]
#[serde(default)]
pub content_length: u64,
/// A standard MIME type describing the format of the object data.
#[serde(rename = "contentType")]
#[serde(default, skip_serializing_if = "Option::is_none")]
pub content_type: Option<String>,
/// Specifies what content encodings have been applied to the object
/// and thus what decoding mechanisms must be applied to obtain the media-type
#[serde(rename = "contentEncoding")]
#[serde(default, skip_serializing_if = "Option::is_none")]
pub content_encoding: Option<String>,
}
/// Result of input item
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct ItemResult {
#[serde(default)]
pub key: String,
/// whether the item succeeded or failed
#[serde(default)]
pub success: bool,
/// optional error message for failures
#[serde(default, skip_serializing_if = "Option::is_none")]
pub error: Option<String>,
}
/// Parameter to list_objects.
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct ListObjectsRequest {
/// Name of the container to search
#[serde(rename = "containerId")]
#[serde(default)]
pub container_id: String,
/// Request object names starting with this value. (Optional)
#[serde(rename = "startWith")]
#[serde(default, skip_serializing_if = "Option::is_none")]
pub start_with: Option<String>,
/// Continuation token passed in ListObjectsResponse.
/// If set, `startWith` is ignored. (Optional)
#[serde(default, skip_serializing_if = "Option::is_none")]
pub continuation: Option<String>,
/// Last item to return (inclusive terminator) (Optional)
#[serde(rename = "endWith")]
#[serde(default, skip_serializing_if = "Option::is_none")]
pub end_with: Option<String>,
/// Optionally, stop returning items before returning this value.
/// (exclusive terminator)
/// If startFrom is "a" and endBefore is "b", and items are ordered
/// alphabetically, then only items beginning with "a" would be returned.
/// (Optional)
#[serde(rename = "endBefore")]
#[serde(default, skip_serializing_if = "Option::is_none")]
pub end_before: Option<String>,
/// maximum number of items to return. If not specified, provider
/// will return an initial set of up to 1000 items. if maxItems > 1000,
/// the provider implementation may return fewer items than requested.
/// (Optional)
#[serde(rename = "maxItems")]
#[serde(default, skip_serializing_if = "Option::is_none")]
pub max_items: Option<u32>,
}
/// Respose to list_objects.
/// If `isLast` is false, the list was truncated by the provider,
/// and the remainder of the objects can be requested with another
/// request using the `continuation` token.
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct ListObjectsResponse {
/// set of objects returned
pub objects: ObjectsInfo,
/// Indicates if the item list is complete, or the last item
/// in a multi-part response.
#[serde(rename = "isLast")]
#[serde(default)]
pub is_last: bool,
/// If `isLast` is false, this value can be used in the `continuation` field
/// of a `ListObjectsRequest`.
/// Clients should not attempt to interpret this field: it may or may not
/// be a real key or object name, and may be obfuscated by the provider.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub continuation: Option<String>,
}
/// result for an operation on a list of inputs
pub type MultiResult = Vec<ItemResult>;
/// Name of an object within a container
pub type ObjectId = String;
/// list of object names
pub type ObjectIds = Vec<ObjectId>;
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct ObjectMetadata {
/// Object identifier that is unique within its container.
/// Naming of objects is determined by the capability provider.
/// An object id could be a path, hash of object contents, or some other unique identifier.
#[serde(rename = "objectId")]
pub object_id: ObjectId,
/// container of the object
#[serde(rename = "containerId")]
pub container_id: ContainerId,
/// size of the object in bytes
#[serde(rename = "contentLength")]
#[serde(default)]
pub content_length: u64,
/// date object was last modified
#[serde(rename = "lastModified")]
#[serde(default, skip_serializing_if = "Option::is_none")]
pub last_modified: Option<Timestamp>,
/// A MIME type of the object
/// see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17
/// Provider implementations _may_ return None for this field for metadata
/// returned from ListObjects
#[serde(rename = "contentType")]
#[serde(default, skip_serializing_if = "Option::is_none")]
pub content_type: Option<String>,
/// Specifies what content encodings have been applied to the object
/// and thus what decoding mechanisms must be applied to obtain the media-type
/// referenced by the contentType field. For more information,
/// see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.
/// Provider implementations _may_ return None for this field for metadata
/// returned from ListObjects
#[serde(rename = "contentEncoding")]
#[serde(default, skip_serializing_if = "Option::is_none")]
pub content_encoding: Option<String>,
}
/// list of object metadata objects
pub type ObjectsInfo = Vec<ObjectMetadata>;
/// Parameter to PutChunk operation
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct PutChunkRequest {
/// upload chunk from the file.
/// if chunk.isLast is set, this will be the last chunk uploaded
pub chunk: Chunk,
/// This value should be set to the `streamId` returned from the initial PutObject.
#[serde(rename = "streamId")]
#[serde(default, skip_serializing_if = "Option::is_none")]
pub stream_id: Option<String>,
/// If set, the receiving provider should cancel the upload process
/// and remove the file.
#[serde(rename = "cancelAndRemove")]
#[serde(default)]
pub cancel_and_remove: bool,
}
/// Parameter for PutObject operation
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct PutObjectRequest {
/// File path and initial data
pub chunk: Chunk,
/// A MIME type of the object
/// see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17
#[serde(rename = "contentType")]
#[serde(default, skip_serializing_if = "Option::is_none")]
pub content_type: Option<String>,
/// Specifies what content encodings have been applied to the object
/// and thus what decoding mechanisms must be applied to obtain the media-type
/// referenced by the contentType field. For more information,
/// see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.
#[serde(rename = "contentEncoding")]
#[serde(default, skip_serializing_if = "Option::is_none")]
pub content_encoding: Option<String>,
}
/// Response to PutObject operation
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct PutObjectResponse {
/// If this is a multipart upload, `streamId` must be returned
/// with subsequent PutChunk requests
#[serde(rename = "streamId")]
#[serde(default, skip_serializing_if = "Option::is_none")]
pub stream_id: Option<String>,
}
/// parameter to removeObjects
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct RemoveObjectsRequest {
/// name of container
#[serde(rename = "containerId")]
pub container_id: ContainerId,
/// list of object names to be removed
pub objects: ObjectIds,
}
/// The BlobStore service, provider side
/// wasmbus.contractId: wasmcloud:blobstore
/// wasmbus.providerReceive
#[async_trait]
pub trait Blobstore {
/// returns the capability contract id for this interface
fn contract_id() -> &'static str {
"wasmcloud:blobstore"
}
/// Returns whether the container exists
async fn container_exists(&self, ctx: &Context, arg: &ContainerId) -> RpcResult<bool>;
/// Creates a container by name, returning success if it worked
/// Note that container names may not be globally unique - just unique within the
/// "namespace" of the connecting actor and linkdef
async fn create_container(&self, ctx: &Context, arg: &ContainerId) -> RpcResult<()>;
/// Retrieves information about the container.
/// Returns error if the container id is invalid or not found.
async fn get_container_info(
&self,
ctx: &Context,
arg: &ContainerId,
) -> RpcResult<ContainerMetadata>;
/// Returns list of container ids
async fn list_containers(&self, ctx: &Context) -> RpcResult<ContainersInfo>;
/// Empty and remove the container(s)
/// The MultiResult list contains one entry for each container
/// that was not successfully removed, with the 'key' value representing the container name.
/// If the MultiResult list is empty, all container removals succeeded.
async fn remove_containers(&self, ctx: &Context, arg: &ContainerIds) -> RpcResult<MultiResult>;
/// Returns whether the object exists
async fn object_exists(&self, ctx: &Context, arg: &ContainerObject) -> RpcResult<bool>;
/// Retrieves information about the object.
/// Returns error if the object id is invalid or not found.
async fn get_object_info(
&self,
ctx: &Context,
arg: &ContainerObject,
) -> RpcResult<ObjectMetadata>;
/// Lists the objects in the container.
/// If the container exists and is empty, the returned `objects` list is empty.
/// Parameters of the request may be used to limit the object names returned
/// with an optional start value, end value, and maximum number of items.
/// The provider may limit the number of items returned. If the list is truncated,
/// the response contains a `continuation` token that may be submitted in
/// a subsequent ListObjects request.
///
/// Optional object metadata fields (i.e., `contentType` and `contentEncoding`) may not be
/// filled in for ListObjects response. To get complete object metadata, use GetObjectInfo.
async fn list_objects(
&self,
ctx: &Context,
arg: &ListObjectsRequest,
) -> RpcResult<ListObjectsResponse>;
/// Removes the objects. In the event any of the objects cannot be removed,
/// the operation continues until all requested deletions have been attempted.
/// The MultiRequest includes a list of errors, one for each deletion request
/// that did not succeed. If the list is empty, all removals succeeded.
async fn remove_objects(
&self,
ctx: &Context,
arg: &RemoveObjectsRequest,
) -> RpcResult<MultiResult>;
/// Requests to start upload of a file/blob to the Blobstore.
/// It is recommended to keep chunks under 1MB to avoid exceeding nats default message size
async fn put_object(
&self,
ctx: &Context,
arg: &PutObjectRequest,
) -> RpcResult<PutObjectResponse>;
/// Requests to retrieve an object. If the object is large, the provider
/// may split the response into multiple parts
/// It is recommended to keep chunks under 1MB to avoid exceeding nats default message size
async fn get_object(
&self,
ctx: &Context,
arg: &GetObjectRequest,
) -> RpcResult<GetObjectResponse>;
/// Uploads a file chunk to a blobstore. This must be called AFTER PutObject
/// It is recommended to keep chunks under 1MB to avoid exceeding nats default message size
async fn put_chunk(&self, ctx: &Context, arg: &PutChunkRequest) -> RpcResult<()>;
}
/// BlobstoreReceiver receives messages defined in the Blobstore service trait
/// The BlobStore service, provider side
#[doc(hidden)]
#[async_trait]
pub trait BlobstoreReceiver: MessageDispatch + Blobstore {
async fn dispatch(&self, ctx: &Context, message: Message<'_>) -> Result<Vec<u8>, RpcError> {
match message.method {
"ContainerExists" => {
let value: ContainerId = wasmbus_rpc::common::deserialize(&message.arg)
.map_err(|e| RpcError::Deser(format!("'ContainerId': {}", e)))?;
let resp = Blobstore::container_exists(self, ctx, &value).await?;
wasmbus_rpc::common::serialize(&resp)
}
"CreateContainer" => {
let value: ContainerId = wasmbus_rpc::common::deserialize(&message.arg)
.map_err(|e| RpcError::Deser(format!("'ContainerId': {}", e)))?;
Blobstore::create_container(self, ctx, &value).await?;
Ok(vec![])
}
"GetContainerInfo" => {
let value: ContainerId = wasmbus_rpc::common::deserialize(&message.arg)
.map_err(|e| RpcError::Deser(format!("'ContainerId': {}", e)))?;
let resp = Blobstore::get_container_info(self, ctx, &value).await?;
wasmbus_rpc::common::serialize(&resp)
}
"ListContainers" => {
let resp = Blobstore::list_containers(self, ctx).await?;
wasmbus_rpc::common::serialize(&resp)
}
"RemoveContainers" => {
let value: ContainerIds = wasmbus_rpc::common::deserialize(&message.arg)
.map_err(|e| RpcError::Deser(format!("'ContainerIds': {}", e)))?;
let resp = Blobstore::remove_containers(self, ctx, &value).await?;
wasmbus_rpc::common::serialize(&resp)
}
"ObjectExists" => {
let value: ContainerObject = wasmbus_rpc::common::deserialize(&message.arg)
.map_err(|e| RpcError::Deser(format!("'ContainerObject': {}", e)))?;
let resp = Blobstore::object_exists(self, ctx, &value).await?;
wasmbus_rpc::common::serialize(&resp)
}
"GetObjectInfo" => {
let value: ContainerObject = wasmbus_rpc::common::deserialize(&message.arg)
.map_err(|e| RpcError::Deser(format!("'ContainerObject': {}", e)))?;
let resp = Blobstore::get_object_info(self, ctx, &value).await?;
wasmbus_rpc::common::serialize(&resp)
}
"ListObjects" => {
let value: ListObjectsRequest = wasmbus_rpc::common::deserialize(&message.arg)
.map_err(|e| RpcError::Deser(format!("'ListObjectsRequest': {}", e)))?;
let resp = Blobstore::list_objects(self, ctx, &value).await?;
wasmbus_rpc::common::serialize(&resp)
}
"RemoveObjects" => {
let value: RemoveObjectsRequest = wasmbus_rpc::common::deserialize(&message.arg)
.map_err(|e| RpcError::Deser(format!("'RemoveObjectsRequest': {}", e)))?;
let resp = Blobstore::remove_objects(self, ctx, &value).await?;
wasmbus_rpc::common::serialize(&resp)
}
"PutObject" => {
let value: PutObjectRequest = wasmbus_rpc::common::deserialize(&message.arg)
.map_err(|e| RpcError::Deser(format!("'PutObjectRequest': {}", e)))?;
let resp = Blobstore::put_object(self, ctx, &value).await?;
wasmbus_rpc::common::serialize(&resp)
}
"GetObject" => {
let value: GetObjectRequest = wasmbus_rpc::common::deserialize(&message.arg)
.map_err(|e| RpcError::Deser(format!("'GetObjectRequest': {}", e)))?;
let resp = Blobstore::get_object(self, ctx, &value).await?;
wasmbus_rpc::common::serialize(&resp)
}
"PutChunk" => {
let value: PutChunkRequest = wasmbus_rpc::common::deserialize(&message.arg)
.map_err(|e| RpcError::Deser(format!("'PutChunkRequest': {}", e)))?;
let _resp = Blobstore::put_chunk(self, ctx, &value).await?;
let buf = Vec::new();
Ok(buf)
}
_ => Err(RpcError::MethodNotHandled(format!(
"Blobstore::{}",
message.method
))),
}
}
}
/// BlobstoreSender sends messages to a Blobstore service
/// The BlobStore service, provider side
/// client for sending Blobstore messages
#[derive(Clone, Debug)]
pub struct BlobstoreSender<T: Transport> {
transport: T,
}
impl<T: Transport> BlobstoreSender<T> {
/// Constructs a BlobstoreSender with the specified transport
pub fn via(transport: T) -> Self {
Self { transport }
}
pub fn set_timeout(&self, interval: std::time::Duration) {
self.transport.set_timeout(interval);
}
}
#[cfg(target_arch = "wasm32")]
impl BlobstoreSender<wasmbus_rpc::actor::prelude::WasmHost> {
/// Constructs a client for sending to a Blobstore provider
/// implementing the 'wasmcloud:blobstore' capability contract, with the "default" link
pub fn new() -> Self {
let transport =
wasmbus_rpc::actor::prelude::WasmHost::to_provider("wasmcloud:blobstore", "default")
.unwrap();
Self { transport }
}
/// Constructs a client for sending to a Blobstore provider
/// implementing the 'wasmcloud:blobstore' capability contract, with the specified link name
pub fn new_with_link(link_name: &str) -> wasmbus_rpc::error::RpcResult<Self> {
let transport =
wasmbus_rpc::actor::prelude::WasmHost::to_provider("wasmcloud:blobstore", link_name)?;
Ok(Self { transport })
}
}
#[async_trait]
impl<T: Transport + std::marker::Sync + std::marker::Send> Blobstore for BlobstoreSender<T> {
#[allow(unused)]
/// Returns whether the container exists
async fn container_exists(&self, ctx: &Context, arg: &ContainerId) -> RpcResult<bool> {
let buf = wasmbus_rpc::common::serialize(arg)?;
let resp = self
.transport
.send(
ctx,
Message {
method: "Blobstore.ContainerExists",
arg: Cow::Borrowed(&buf),
},
None,
)
.await?;
let value: bool = wasmbus_rpc::common::deserialize(&resp)
.map_err(|e| RpcError::Deser(format!("'{}': Boolean", e)))?;
Ok(value)
}
#[allow(unused)]
/// Creates a container by name, returning success if it worked
/// Note that container names may not be globally unique - just unique within the
/// "namespace" of the connecting actor and linkdef
async fn create_container(&self, ctx: &Context, arg: &ContainerId) -> RpcResult<()> {
let buf = wasmbus_rpc::common::serialize(arg)?;
let resp = self
.transport
.send(
ctx,
Message {
method: "Blobstore.CreateContainer",
arg: Cow::Borrowed(&buf),
},
None,
)
.await?;
Ok(())
}
#[allow(unused)]
/// Retrieves information about the container.
/// Returns error if the container id is invalid or not found.
async fn get_container_info(
&self,
ctx: &Context,
arg: &ContainerId,
) -> RpcResult<ContainerMetadata> {
let buf = wasmbus_rpc::common::serialize(arg)?;
let resp = self
.transport
.send(
ctx,
Message {
method: "Blobstore.GetContainerInfo",
arg: Cow::Borrowed(&buf),
},
None,
)
.await?;
let value: ContainerMetadata = wasmbus_rpc::common::deserialize(&resp)
.map_err(|e| RpcError::Deser(format!("'{}': ContainerMetadata", e)))?;
Ok(value)
}
#[allow(unused)]
/// Returns list of container ids
async fn list_containers(&self, ctx: &Context) -> RpcResult<ContainersInfo> {
let buf = *b"";
let resp = self
.transport
.send(
ctx,
Message {
method: "Blobstore.ListContainers",
arg: Cow::Borrowed(&buf),
},
None,
)
.await?;
let value: ContainersInfo = wasmbus_rpc::common::deserialize(&resp)
.map_err(|e| RpcError::Deser(format!("'{}': ContainersInfo", e)))?;
Ok(value)
}
#[allow(unused)]
/// Empty and remove the container(s)
/// The MultiResult list contains one entry for each container
/// that was not successfully removed, with the 'key' value representing the container name.
/// If the MultiResult list is empty, all container removals succeeded.
async fn remove_containers(&self, ctx: &Context, arg: &ContainerIds) -> RpcResult<MultiResult> {
let buf = wasmbus_rpc::common::serialize(arg)?;
let resp = self
.transport
.send(
ctx,
Message {
method: "Blobstore.RemoveContainers",
arg: Cow::Borrowed(&buf),
},
None,
)
.await?;
let value: MultiResult = wasmbus_rpc::common::deserialize(&resp)
.map_err(|e| RpcError::Deser(format!("'{}': MultiResult", e)))?;
Ok(value)
}
#[allow(unused)]
/// Returns whether the object exists
async fn object_exists(&self, ctx: &Context, arg: &ContainerObject) -> RpcResult<bool> {
let buf = wasmbus_rpc::common::serialize(arg)?;
let resp = self
.transport
.send(
ctx,
Message {
method: "Blobstore.ObjectExists",
arg: Cow::Borrowed(&buf),
},
None,
)
.await?;
let value: bool = wasmbus_rpc::common::deserialize(&resp)
.map_err(|e| RpcError::Deser(format!("'{}': Boolean", e)))?;
Ok(value)
}
#[allow(unused)]
/// Retrieves information about the object.
/// Returns error if the object id is invalid or not found.
async fn get_object_info(
&self,
ctx: &Context,
arg: &ContainerObject,
) -> RpcResult<ObjectMetadata> {
let buf = wasmbus_rpc::common::serialize(arg)?;
let resp = self
.transport
.send(
ctx,
Message {
method: "Blobstore.GetObjectInfo",
arg: Cow::Borrowed(&buf),
},
None,
)
.await?;
let value: ObjectMetadata = wasmbus_rpc::common::deserialize(&resp)
.map_err(|e| RpcError::Deser(format!("'{}': ObjectMetadata", e)))?;
Ok(value)
}
#[allow(unused)]
/// Lists the objects in the container.
/// If the container exists and is empty, the returned `objects` list is empty.
/// Parameters of the request may be used to limit the object names returned
/// with an optional start value, end value, and maximum number of items.
/// The provider may limit the number of items returned. If the list is truncated,
/// the response contains a `continuation` token that may be submitted in
/// a subsequent ListObjects request.
///
/// Optional object metadata fields (i.e., `contentType` and `contentEncoding`) may not be
/// filled in for ListObjects response. To get complete object metadata, use GetObjectInfo.
async fn list_objects(
&self,
ctx: &Context,
arg: &ListObjectsRequest,
) -> RpcResult<ListObjectsResponse> {
let buf = wasmbus_rpc::common::serialize(arg)?;
let resp = self
.transport
.send(
ctx,
Message {
method: "Blobstore.ListObjects",
arg: Cow::Borrowed(&buf),
},
None,
)
.await?;
let value: ListObjectsResponse = wasmbus_rpc::common::deserialize(&resp)
.map_err(|e| RpcError::Deser(format!("'{}': ListObjectsResponse", e)))?;
Ok(value)
}
#[allow(unused)]
/// Removes the objects. In the event any of the objects cannot be removed,
/// the operation continues until all requested deletions have been attempted.
/// The MultiRequest includes a list of errors, one for each deletion request
/// that did not succeed. If the list is empty, all removals succeeded.
async fn remove_objects(
&self,
ctx: &Context,
arg: &RemoveObjectsRequest,
) -> RpcResult<MultiResult> {
let buf = wasmbus_rpc::common::serialize(arg)?;
let resp = self
.transport
.send(
ctx,
Message {
method: "Blobstore.RemoveObjects",
arg: Cow::Borrowed(&buf),
},
None,
)
.await?;
let value: MultiResult = wasmbus_rpc::common::deserialize(&resp)
.map_err(|e| RpcError::Deser(format!("'{}': MultiResult", e)))?;
Ok(value)
}
#[allow(unused)]
/// Requests to start upload of a file/blob to the Blobstore.
/// It is recommended to keep chunks under 1MB to avoid exceeding nats default message size
async fn put_object(
&self,
ctx: &Context,
arg: &PutObjectRequest,
) -> RpcResult<PutObjectResponse> {
let buf = wasmbus_rpc::common::serialize(arg)?;
let resp = self
.transport
.send(
ctx,
Message {
method: "Blobstore.PutObject",
arg: Cow::Borrowed(&buf),
},
None,
)
.await?;
let value: PutObjectResponse = wasmbus_rpc::common::deserialize(&resp)
.map_err(|e| RpcError::Deser(format!("'{}': PutObjectResponse", e)))?;
Ok(value)
}
#[allow(unused)]
/// Requests to retrieve an object. If the object is large, the provider
/// may split the response into multiple parts
/// It is recommended to keep chunks under 1MB to avoid exceeding nats default message size
async fn get_object(
&self,
ctx: &Context,
arg: &GetObjectRequest,
) -> RpcResult<GetObjectResponse> {
let buf = wasmbus_rpc::common::serialize(arg)?;
let resp = self
.transport
.send(
ctx,
Message {
method: "Blobstore.GetObject",
arg: Cow::Borrowed(&buf),
},
None,
)
.await?;
let value: GetObjectResponse = wasmbus_rpc::common::deserialize(&resp)
.map_err(|e| RpcError::Deser(format!("'{}': GetObjectResponse", e)))?;
Ok(value)
}
#[allow(unused)]
/// Uploads a file chunk to a blobstore. This must be called AFTER PutObject
/// It is recommended to keep chunks under 1MB to avoid exceeding nats default message size
async fn put_chunk(&self, ctx: &Context, arg: &PutChunkRequest) -> RpcResult<()> {
let buf = wasmbus_rpc::common::serialize(arg)?;
let resp = self
.transport
.send(
ctx,
Message {
method: "Blobstore.PutChunk",
arg: Cow::Borrowed(&buf),
},
None,
)
.await?;
Ok(())
}
}
/// The BlobStore service, actor side
/// wasmbus.contractId: wasmcloud:blobstore
/// wasmbus.actorReceive
#[async_trait]
pub trait ChunkReceiver {
/// returns the capability contract id for this interface
fn contract_id() -> &'static str {
"wasmcloud:blobstore"
}
/// Receives a file chunk from a blobstore.
/// A blobstore provider invokes this operation on actors in response to the GetObject request.
/// If the response sets cancelDownload, the provider will stop downloading chunks
async fn receive_chunk(&self, ctx: &Context, arg: &Chunk) -> RpcResult<ChunkResponse>;
}
/// ChunkReceiverReceiver receives messages defined in the ChunkReceiver service trait
/// The BlobStore service, actor side
#[doc(hidden)]
#[async_trait]
pub trait ChunkReceiverReceiver: MessageDispatch + ChunkReceiver {
async fn dispatch(&self, ctx: &Context, message: Message<'_>) -> Result<Vec<u8>, RpcError> {
match message.method {
"ReceiveChunk" => {
let value: Chunk = wasmbus_rpc::common::deserialize(&message.arg)
.map_err(|e| RpcError::Deser(format!("'Chunk': {}", e)))?;
let resp = ChunkReceiver::receive_chunk(self, ctx, &value).await?;
let buf = wasmbus_rpc::common::serialize(&resp)?;
Ok(buf)
}
_ => Err(RpcError::MethodNotHandled(format!(
"ChunkReceiver::{}",
message.method
))),
}
}
}
/// ChunkReceiverSender sends messages to a ChunkReceiver service
/// The BlobStore service, actor side
/// client for sending ChunkReceiver messages
#[derive(Clone, Debug)]
pub struct ChunkReceiverSender<T: Transport> {
transport: T,
}
impl<T: Transport> ChunkReceiverSender<T> {
/// Constructs a ChunkReceiverSender with the specified transport
pub fn via(transport: T) -> Self {
Self { transport }
}
pub fn set_timeout(&self, interval: std::time::Duration) {
self.transport.set_timeout(interval);
}
}
#[cfg(not(target_arch = "wasm32"))]
impl<'send> ChunkReceiverSender<wasmbus_rpc::provider::ProviderTransport<'send>> {
/// Constructs a Sender using an actor's LinkDefinition,
/// Uses the provider's HostBridge for rpc
pub fn for_actor(ld: &'send wasmbus_rpc::core::LinkDefinition) -> Self {
Self {
transport: wasmbus_rpc::provider::ProviderTransport::new(ld, None),
}
}
}
#[cfg(target_arch = "wasm32")]
impl ChunkReceiverSender<wasmbus_rpc::actor::prelude::WasmHost> {
/// Constructs a client for actor-to-actor messaging
/// using the recipient actor's public key
pub fn to_actor(actor_id: &str) -> Self {
let transport =
wasmbus_rpc::actor::prelude::WasmHost::to_actor(actor_id.to_string()).unwrap();
Self { transport }
}
}
#[async_trait]
impl<T: Transport + std::marker::Sync + std::marker::Send> ChunkReceiver
for ChunkReceiverSender<T>
{
#[allow(unused)]
/// Receives a file chunk from a blobstore.
/// A blobstore provider invokes this operation on actors in response to the GetObject request.
/// If the response sets cancelDownload, the provider will stop downloading chunks
async fn receive_chunk(&self, ctx: &Context, arg: &Chunk) -> RpcResult<ChunkResponse> {
let buf = wasmbus_rpc::common::serialize(arg)?;
let resp = self
.transport
.send(
ctx,
Message {
method: "ChunkReceiver.ReceiveChunk",
arg: Cow::Borrowed(&buf),
},
None,
)
.await?;
let value: ChunkResponse = wasmbus_rpc::common::deserialize(&resp)
.map_err(|e| RpcError::Deser(format!("'{}': ChunkResponse", e)))?;
Ok(value)
}
}