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] Implement Writer for List[Byte] #3758

Open
wants to merge 1 commit into
base: nightly
Choose a base branch
from
Open
Show file tree
Hide file tree
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
41 changes: 41 additions & 0 deletions stdlib/src/collections/list.mojo
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,35 @@ struct List[T: CollectionElement, hint_trivial_type: Bool = False](
self.write_to(output)
return output^

fn write_bytes(inout self, bytes: Span[Byte, _]):
"""
Write a byte span to this List. `T` **must** be of type `Byte`.

Args:
bytes: The byte span to write to this String. Must NOT be
null terminated.
"""
constrained[_type_is_eq[T, Byte]()]()
self.extend(rebind[Span[T, bytes.origin]](bytes))
Copy link
Contributor

@martinvuyk martinvuyk Nov 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the extend method has a lot of overhead if you know it's a DType. Until we land #3577 this logic will have to stay here

Suggested change
self.extend(rebind[Span[T, bytes.origin]](bytes))
self.reserve(len(self) + len(bytes))
memcpy(
self.unsafe_ptr() + len(self),
bytes.unsafe_ptr().bitcast[T](),
len(bytes),
)


fn write[*Ts: Writable](inout self, *args: *Ts):
"""Write a sequence of Writable arguments to the provided Writer.
`T` **must** be of type `Byte`.

Parameters:
Ts: Types of the provided argument sequence.

Args:
args: Sequence of arguments to write to this Writer.
"""
constrained[_type_is_eq[T, Byte]()]()

@parameter
fn write_arg[T: Writable](arg: T):
arg.write_to[__type_of(self)](self)

args.each[write_arg]()

@no_inline
fn write_to[
W: Writer, U: RepresentableCollectionElement, //
Expand Down Expand Up @@ -592,6 +621,18 @@ struct List[T: CollectionElement, hint_trivial_type: Bool = False](
# list.
self.size = final_size

fn extend(inout self, other: Span[T]):
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion Add some unit tests for this new public API method.

"""Extends this list by copying the elements of `other`.

Args:
other: Span whose elements will be added in order at the end of this list.
"""
var final_size = len(self) + len(other)
self.reserve(final_size)

for item in other:
self.append(item[])

fn pop(inout self, i: Int = -1) -> T:
"""Pops a value from the list at the given index.

Expand Down
13 changes: 13 additions & 0 deletions stdlib/test/collections/test_list.mojo
Original file line number Diff line number Diff line change
Expand Up @@ -922,6 +922,19 @@ def test_list_repr():
assert_equal(empty.__repr__(), "[]")


def test_writer():
var l = List[Byte]()
var s = "abc".as_bytes()
l.write_bytes(s)
assert_equal(l[0], ord("a"))
assert_equal(l[1], ord("b"))
assert_equal(l[2], ord("c"))
var l2 = List[Byte]()
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question Can you explain this part of the test? I'm not sure I follow.

assert_equal(l2[0], 0)
assert_equal(l2[1], 1)
assert_equal(l2[2], 2)


# ===-------------------------------------------------------------------===#
# main
# ===-------------------------------------------------------------------===#
Expand Down
Loading