Skip to content
This repository has been archived by the owner on Mar 27, 2024. It is now read-only.

docs: Updated storage interface documentation #3216

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
docs: Updated storage interface documentation
Updated the documentation for the Put method to indicate that in the set of tags used on a single Put call, those tags must have unique tag names. The reason for this is because several of our major storage implementations in aries-framework-go-ext have this implementation, so this note was added to help ensure consistent behaviour.

Signed-off-by: Derek Trider <[email protected]>
Derek Trider committed Apr 12, 2022

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit 2825074751ea09840f947f0cf37dab3a8141d177
1 change: 1 addition & 0 deletions spi/storage/storage.go
Original file line number Diff line number Diff line change
@@ -184,6 +184,7 @@ type Store interface {
// with data put in and data retrieved, as the marshalled representation may be different - always unmarshal data
// first before comparing.
// If key is empty or value is nil, then an error will be returned.
// A single key-value pair cannot have multiple tags that share the same tag name.
Put(key string, value []byte, tags ...Tag) error

// Get fetches the value associated with the given key.