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.

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

[stdlib] [NFC] Simplify String List[Byte] constructor #3856

Open
wants to merge 6 commits into
base: nightly
Choose a base branch
from
Open
Changes from 3 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
59 changes: 8 additions & 51 deletions stdlib/src/collections/string.mojo
Original file line number Diff line number Diff line change
Expand Up @@ -784,68 +784,25 @@ struct String(

@always_inline
@implicit
fn __init__(out self, owned impl: List[UInt8, *_]):
"""Construct a string from a buffer of bytes without copying the
allocated data.

The buffer must be terminated with a null byte:

```mojo
var buf = List[UInt8]()
buf.append(ord('H'))
buf.append(ord('i'))
buf.append(0)
var hi = String(buf)
```
fn __init__(out self, impl: List[Byte, *_]):
lsh marked this conversation as resolved.
Show resolved Hide resolved
"""Construct a string from a buffer of null-terminated bytes, copying
the allocated data. Use the transfer operator `^` to avoid the copy.

Args:
impl: The buffer.
"""
debug_assert(
len(impl) > 0 and impl[-1] == 0,
"expected last element of String buffer to be null terminator",
)
# We make a backup because steal_data() will clear size and capacity.
var size = impl.size
debug_assert(
impl[size - 1] == 0,
"expected last element of String buffer to be null terminator",
)
var capacity = impl.capacity
self._buffer = Self._buffer_type(
ptr=impl.steal_data(), length=size, capacity=capacity
)

@always_inline
@implicit
fn __init__(out self, impl: Self._buffer_type):
"""Construct a string from a buffer of bytes, copying the allocated
data. Use the transfer operator ^ to avoid the copy.
impl: The null-terminated buffer.

The buffer must be terminated with a null byte:
Examples:

```mojo
var buf = List[UInt8]()
buf.append(ord('H'))
buf.append(ord('i'))
buf.append(0)
var hi = String(buf)
print(String(List[Byte](ord('h'), ord('i'), 0))) # hi
```

Args:
impl: The buffer.
.
"""
debug_assert(
len(impl) > 0 and impl[-1] == 0,
"expected last element of String buffer to be null terminator",
)
# We make a backup because steal_data() will clear size and capacity.
var size = impl.size
debug_assert(
impl[size - 1] == 0,
"expected last element of String buffer to be null terminator",
)
self._buffer = impl
self._buffer = rebind[Self._buffer_type](impl)

@always_inline
fn __init__(out self):
Expand Down
Loading