Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(types): improve datasource write api #3763

Merged
merged 1 commit into from
Dec 19, 2023
Merged

feat(types): improve datasource write api #3763

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions types/detect/detect.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,16 +98,16 @@ var ErrFailedToUnmarshal = errors.New("given value could not be unmarshaled")

type WriteableDataSource interface {
DataSource
// Write a value to a key in the data source. The value can not strictly match the schema defined
// Write values to keys in the data source. The values may not strictly match the schema defined
// in the data source, however the implementation must be able to unmarshal it successfully to some form
// where it can be eventually represented by the schema.
//
// The following errors should be returned for the appropriate cases:
//
// - ErrKeyNotSupported - When the key used does not match to a support key
// - ErrFailedToUnmarshal - When the value given could not be unmarshalled to an expected type
// - ErrKeyNotSupported - When a given key does not match to supported key type
// - ErrFailedToUnmarshal - When a value given could not be unmarshalled to an expected type
// - Otherwise errors may vary.
Write(key interface{}, value interface{}) error
Write(data map[interface{}]interface{}) error
// The types of values the data source supports writing.
Values() []string
}
Loading