vieter-v
/
v
2
0
Fork 0
Code Issues Pull Requests Releases Activity

builtin: add missing fn documentation to option.v, fix naming of arguments. (#7386)

pull/7402/head
Larpon 2020-12-18 23:27:35 +01:00 committed by GitHub
parent bcda0eeadc
commit 6854ba27e2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
vlib/builtin/option.v
View File

@ -2,6 +2,7 @@
// Use of this source code is governed by an MIT license // Use of this source code is governed by an MIT license
// that can be found in the LICENSE file. // that can be found in the LICENSE file.
module builtin module builtin
/* /*
struct Option2<T> { struct Option2<T> {
ok bool ok bool
@ -11,31 +12,29 @@ struct Option2<T> {
data T data T
} }
*/ */
// OptionBase is the the base of V's internal optional return system.
struct OptionBase { struct OptionBase {
ok bool ok bool
is_none bool is_none bool
error string error string
ecode int ecode int
// Data is trailing after ecode // Data is trailing after ecode
// and is not included in here but in the // and is not included in here but in the
// derived Option_xxx types // derived Option_xxx types
} }
// `fn foo() ?Foo { return foo }` => `fn foo() ?Foo { return opt_ok(foo); }` // `fn foo() ?Foo { return foo }` => `fn foo() ?Foo { return opt_ok(foo); }`
fn opt_ok2(data voidptr, mut option &OptionBase, size int) { fn opt_ok2(data voidptr, mut option OptionBase, size int) {
unsafe { unsafe {
*option = OptionBase { *option = OptionBase{
ok: true ok: true
} }
// use ecode to get the end of OptionBase and then memcpy into it // use ecode to get the end of OptionBase and then memcpy into it
C.memcpy(byteptr(&option.ecode) + sizeof(int), data, size) C.memcpy(byteptr(&option.ecode) + sizeof(int), data, size)
} }
} }
// Old option type used for bootstrapping // Option is the old option type used for bootstrapping
struct Option { struct Option {
ok bool ok bool
is_none bool is_none bool
@ -43,17 +42,18 @@ struct Option {
ecode int ecode int
} }
// str returns the string representation of the Option.
pub fn (o Option) str() string { pub fn (o Option) str() string {
if o.ok && !o.is_none { if o.ok && !o.is_none {
return 'Option{ ok }' return 'Option{ ok }'
} }
if o.is_none { if o.is_none {
return 'Option{ none }' return 'Option{ none }'
} }
return 'Option{ error: "${o.error}" }' return 'Option{ error: "$o.error" }'
} }
// used internally when returning `none` // opt_none is used internally when returning `none`.
fn opt_none() Option { fn opt_none() Option {
return Option{ return Option{
ok: false ok: false
@ -61,19 +61,23 @@ fn opt_none() Option {
} }
} }
pub fn error(s string) Option { // error returns an optional containing the error given in `message`.
// `if ouch { return error('an error occurred') }`
pub fn error(message string) Option {
return Option{ return Option{
ok: false ok: false
is_none: false is_none: false
error: s error: message
} }
} }
pub fn error_with_code(s string, code int) Option { // error_with_code returns an optional containing both error `message` and error `code`.
// `if ouch { return error_with_code('an error occurred',1) }`
pub fn error_with_code(message string, code int) Option {
return Option{ return Option{
ok: false ok: false
is_none: false is_none: false
error: s error: message
ecode: code ecode: code
} }
} }