Skip to content

Commit

Permalink
rename frame.Write to frame.Append
Browse files Browse the repository at this point in the history
  • Loading branch information
@marten-seemann
marten-seemann committed Aug 28, 2022
1 parent 3ca1001 commit ab6d664
Show file tree
Hide file tree
Showing 50 changed files with 112 additions and 112 deletions.
4 changes: 2 additions & 2 deletions connection_test.go
View file
Expand Up @@ -561,7 +561,7 @@ var _ = Describe("Connection", func() {
}
Expect(hdr.Write(buf, conn.version)).To(Succeed())
unpacker.EXPECT().Unpack(gomock.Any(), gomock.Any(), gomock.Any()).DoAndReturn(func(*wire.Header, time.Time, []byte) (*unpackedPacket, error) {
b, err := (&wire.ConnectionCloseFrame{ErrorCode: uint64(qerr.StreamLimitError)}).Write(nil, conn.version)
b, err := (&wire.ConnectionCloseFrame{ErrorCode: uint64(qerr.StreamLimitError)}).Append(nil, conn.version)
Expect(err).ToNot(HaveOccurred())
return &unpackedPacket{
hdr: hdr,
Expand Down Expand Up @@ -754,7 +754,7 @@ var _ = Describe("Connection", func() {
PacketNumberLen: protocol.PacketNumberLen1,
}
rcvTime := time.Now().Add(-10 * time.Second)
b, err := (&wire.PingFrame{}).Write(nil, conn.version)
b, err := (&wire.PingFrame{}).Append(nil, conn.version)
Expect(err).ToNot(HaveOccurred())
packet := getPacket(hdr, nil)
packet.ecn = protocol.ECT1
Expand Down
4 changes: 2 additions & 2 deletions fuzzing/frames/cmd/corpus.go
View file
Expand Up @@ -252,7 +252,7 @@ func getFrames() []wire.Frame {

func main() {
for _, f := range getFrames() {
b, err := f.Write(nil, version)
b, err := f.Append(nil, version)
if err != nil {
log.Fatal(err)
}
Expand All @@ -271,7 +271,7 @@ func main() {
}
f := frames[rand.Intn(len(frames))]
var err error
b, err = f.Write(b, version)
b, err = f.Append(b, version)
if err != nil {
log.Fatal(err)
}
Expand Down
2 changes: 1 addition & 1 deletion fuzzing/frames/fuzz.go
View file
Expand Up @@ -69,7 +69,7 @@ func Fuzz(data []byte) int {
}
}
lenBefore := len(b)
b, err := f.Write(b, version)
b, err := f.Append(b, version)
if err != nil {
panic(fmt.Sprintf("Error writing frame %#v: %s", f, err))
}
Expand Down
2 changes: 1 addition & 1 deletion internal/testutils/testutils.go
View file
Expand Up @@ -23,7 +23,7 @@ func packRawPayload(version protocol.VersionNumber, frames []wire.Frame) []byte
var b []byte
for _, cf := range frames {
var err error
b, err = cf.Write(b, version)
b, err = cf.Append(b, version)
if err != nil {
panic(err)
}
Expand Down
2 changes: 1 addition & 1 deletion internal/wire/ack_frame.go
View file
Expand Up @@ -107,7 +107,7 @@ func parseAckFrame(r *bytes.Reader, ackDelayExponent uint8, _ protocol.VersionNu
}

// Write writes an ACK frame.
func (f *AckFrame) Write(b []byte, _ protocol.VersionNumber) ([]byte, error) {
func (f *AckFrame) Append(b []byte, _ protocol.VersionNumber) ([]byte, error) {
hasECN := f.ECT0 > 0 || f.ECT1 > 0 || f.ECNCE > 0
if hasECN {
b = append(b, 0b11)
Expand Down
16 changes: 8 additions & 8 deletions internal/wire/ack_frame_test.go
View file
Expand Up @@ -120,7 +120,7 @@ var _ = Describe("ACK Frame (for IETF QUIC)", func() {
AckRanges: []AckRange{{Smallest: 1, Largest: 1}},
DelayTime: delayTime,
}
b, err := f.Write(nil, protocol.Version1)
b, err := f.Append(nil, protocol.Version1)
Expect(err).ToNot(HaveOccurred())
for i := uint8(0); i < 8; i++ {
r := bytes.NewReader(b)
Expand Down Expand Up @@ -205,7 +205,7 @@ var _ = Describe("ACK Frame (for IETF QUIC)", func() {
f := &AckFrame{
AckRanges: []AckRange{{Smallest: 100, Largest: 1337}},
}
b, err := f.Write(nil, protocol.Version1)
b, err := f.Append(nil, protocol.Version1)
Expect(err).ToNot(HaveOccurred())
expected := []byte{0x2}
expected = append(expected, encodeVarInt(1337)...) // largest acked
Expand All @@ -222,7 +222,7 @@ var _ = Describe("ACK Frame (for IETF QUIC)", func() {
ECT1: 37,
ECNCE: 12345,
}
b, err := f.Write(nil, protocol.Version1)
b, err := f.Append(nil, protocol.Version1)
Expect(err).ToNot(HaveOccurred())
Expect(b).To(HaveLen(int(f.Length(protocol.Version1))))
expected := []byte{0x3}
Expand All @@ -241,7 +241,7 @@ var _ = Describe("ACK Frame (for IETF QUIC)", func() {
AckRanges: []AckRange{{Smallest: 0x2eadbeef, Largest: 0x2eadbeef}},
DelayTime: 18 * time.Millisecond,
}
b, err := f.Write(nil, protocol.Version1)
b, err := f.Append(nil, protocol.Version1)
Expect(err).ToNot(HaveOccurred())
Expect(b).To(HaveLen(int(f.Length(protocol.Version1))))
r := bytes.NewReader(b)
Expand All @@ -257,7 +257,7 @@ var _ = Describe("ACK Frame (for IETF QUIC)", func() {
f := &AckFrame{
AckRanges: []AckRange{{Smallest: 0x1337, Largest: 0x2eadbeef}},
}
b, err := f.Write(nil, protocol.Version1)
b, err := f.Append(nil, protocol.Version1)
Expect(err).ToNot(HaveOccurred())
Expect(b).To(HaveLen(int(f.Length(protocol.Version1))))
r := bytes.NewReader(b)
Expand All @@ -276,7 +276,7 @@ var _ = Describe("ACK Frame (for IETF QUIC)", func() {
},
}
Expect(f.validateAckRanges()).To(BeTrue())
b, err := f.Write(nil, protocol.Version1)
b, err := f.Append(nil, protocol.Version1)
Expect(err).ToNot(HaveOccurred())
Expect(b).To(HaveLen(int(f.Length(protocol.Version1))))
r := bytes.NewReader(b)
Expand All @@ -297,7 +297,7 @@ var _ = Describe("ACK Frame (for IETF QUIC)", func() {
},
}
Expect(f.validateAckRanges()).To(BeTrue())
b, err := f.Write(nil, protocol.Version1)
b, err := f.Append(nil, protocol.Version1)
Expect(err).ToNot(HaveOccurred())
Expect(b).To(HaveLen(int(f.Length(protocol.Version1))))
r := bytes.NewReader(b)
Expand All @@ -316,7 +316,7 @@ var _ = Describe("ACK Frame (for IETF QUIC)", func() {
}
f := &AckFrame{AckRanges: ackRanges}
Expect(f.validateAckRanges()).To(BeTrue())
b, err := f.Write(nil, protocol.Version1)
b, err := f.Append(nil, protocol.Version1)
Expect(err).ToNot(HaveOccurred())
Expect(b).To(HaveLen(int(f.Length(protocol.Version1))))
// make sure the ACK frame is *a little bit* smaller than the MaxAckFrameSize
Expand Down
2 changes: 1 addition & 1 deletion internal/wire/connection_close_frame.go
View file
Expand Up @@ -66,7 +66,7 @@ func (f *ConnectionCloseFrame) Length(protocol.VersionNumber) protocol.ByteCount
return length
}

func (f *ConnectionCloseFrame) Write(b []byte, _ protocol.VersionNumber) ([]byte, error) {
func (f *ConnectionCloseFrame) Append(b []byte, _ protocol.VersionNumber) ([]byte, error) {
if f.IsApplicationError {
b = append(b, 0x1d)
} else {
Expand Down
10 changes: 5 additions & 5 deletions internal/wire/connection_close_frame_test.go
View file
Expand Up @@ -88,7 +88,7 @@ var _ = Describe("CONNECTION_CLOSE Frame", func() {
ErrorCode: 0xbeef,
FrameType: 0x12345,
}
b, err := frame.Write(nil, protocol.Version1)
b, err := frame.Append(nil, protocol.Version1)
Expect(err).ToNot(HaveOccurred())
expected := []byte{0x1c}
expected = append(expected, encodeVarInt(0xbeef)...)
Expand All @@ -102,7 +102,7 @@ var _ = Describe("CONNECTION_CLOSE Frame", func() {
ErrorCode: 0xdead,
ReasonPhrase: "foobar",
}
b, err := frame.Write(nil, protocol.Version1)
b, err := frame.Append(nil, protocol.Version1)
Expect(err).ToNot(HaveOccurred())
expected := []byte{0x1c}
expected = append(expected, encodeVarInt(0xdead)...)
Expand All @@ -118,7 +118,7 @@ var _ = Describe("CONNECTION_CLOSE Frame", func() {
ErrorCode: 0xdead,
ReasonPhrase: "foobar",
}
b, err := frame.Write(nil, protocol.Version1)
b, err := frame.Append(nil, protocol.Version1)
Expect(err).ToNot(HaveOccurred())
expected := []byte{0x1d}
expected = append(expected, encodeVarInt(0xdead)...)
Expand All @@ -133,7 +133,7 @@ var _ = Describe("CONNECTION_CLOSE Frame", func() {
FrameType: 0xdeadbeef,
ReasonPhrase: "foobar",
}
b, err := f.Write(nil, protocol.Version1)
b, err := f.Append(nil, protocol.Version1)
Expect(err).ToNot(HaveOccurred())
Expect(b).To(HaveLen(int(f.Length(protocol.Version1))))
})
Expand All @@ -144,7 +144,7 @@ var _ = Describe("CONNECTION_CLOSE Frame", func() {
ErrorCode: 0xcafe,
ReasonPhrase: "foobar",
}
b, err := f.Write(nil, protocol.Version1)
b, err := f.Append(nil, protocol.Version1)
Expect(err).ToNot(HaveOccurred())
Expect(b).To(HaveLen(int(f.Length(protocol.Version1))))
})
Expand Down
2 changes: 1 addition & 1 deletion internal/wire/crypto_frame.go
View file
Expand Up @@ -42,7 +42,7 @@ func parseCryptoFrame(r *bytes.Reader, _ protocol.VersionNumber) (*CryptoFrame,
return frame, nil
}

func (f *CryptoFrame) Write(b []byte, _ protocol.VersionNumber) ([]byte, error) {
func (f *CryptoFrame) Append(b []byte, _ protocol.VersionNumber) ([]byte, error) {
b = append(b, 0x6)
b = quicvarint.Append(b, uint64(f.Offset))
b = quicvarint.Append(b, uint64(len(f.Data)))
Expand Down
6 changes: 3 additions & 3 deletions internal/wire/crypto_frame_test.go
View file
Expand Up @@ -45,7 +45,7 @@ var _ = Describe("CRYPTO frame", func() {
Offset: 0x123456,
Data: []byte("foobar"),
}
b, err := f.Write(nil, protocol.Version1)
b, err := f.Append(nil, protocol.Version1)
Expect(err).ToNot(HaveOccurred())
expected := []byte{0x6}
expected = append(expected, encodeVarInt(0x123456)...) // offset
Expand All @@ -70,13 +70,13 @@ var _ = Describe("CRYPTO frame", func() {
if maxDataLen == 0 { // 0 means that no valid CRYTPO frame can be written
// check that writing a minimal size CRYPTO frame (i.e. with 1 byte data) is actually larger than the desired size
f.Data = []byte{0}
b, err := f.Write(nil, protocol.Version1)
b, err := f.Append(nil, protocol.Version1)
Expect(err).ToNot(HaveOccurred())
Expect(len(b)).To(BeNumerically(">", i))
continue
}
f.Data = data[:int(maxDataLen)]
b, err := f.Write(nil, protocol.Version1)
b, err := f.Append(nil, protocol.Version1)
Expect(err).ToNot(HaveOccurred())
// There's *one* pathological case, where a data length of x can be encoded into 1 byte
// but a data lengths of x+1 needs 2 bytes
Expand Down
2 changes: 1 addition & 1 deletion internal/wire/data_blocked_frame.go
View file
Expand Up @@ -25,7 +25,7 @@ func parseDataBlockedFrame(r *bytes.Reader, _ protocol.VersionNumber) (*DataBloc
}, nil
}

func (f *DataBlockedFrame) Write(b []byte, version protocol.VersionNumber) ([]byte, error) {
func (f *DataBlockedFrame) Append(b []byte, version protocol.VersionNumber) ([]byte, error) {
b = append(b, 0x14)
b = quicvarint.Append(b, uint64(f.MaximumData))
return b, nil
Expand Down
2 changes: 1 addition & 1 deletion internal/wire/data_blocked_frame_test.go
View file
Expand Up @@ -38,7 +38,7 @@ var _ = Describe("DATA_BLOCKED frame", func() {
Context("when writing", func() {
It("writes a sample frame", func() {
frame := DataBlockedFrame{MaximumData: 0xdeadbeef}
b, err := frame.Write(nil, protocol.VersionWhatever)
b, err := frame.Append(nil, protocol.VersionWhatever)
Expect(err).ToNot(HaveOccurred())
expected := []byte{0x14}
expected = append(expected, encodeVarInt(0xdeadbeef)...)
Expand Down
2 changes: 1 addition & 1 deletion internal/wire/datagram_frame.go
View file
Expand Up @@ -44,7 +44,7 @@ func parseDatagramFrame(r *bytes.Reader, _ protocol.VersionNumber) (*DatagramFra
return f, nil
}

func (f *DatagramFrame) Write(b []byte, _ protocol.VersionNumber) ([]byte, error) {
func (f *DatagramFrame) Append(b []byte, _ protocol.VersionNumber) ([]byte, error) {
typeByte := uint8(0x30)
if f.DataLenPresent {
typeByte ^= 0b1
Expand Down
12 changes: 6 additions & 6 deletions internal/wire/datagram_frame_test.go
View file
Expand Up @@ -64,7 +64,7 @@ var _ = Describe("STREAM frame", func() {
DataLenPresent: true,
Data: []byte("foobar"),
}
b, err := f.Write(nil, protocol.Version1)
b, err := f.Append(nil, protocol.Version1)
Expect(err).ToNot(HaveOccurred())
expected := []byte{0x30 ^ 0x1}
expected = append(expected, encodeVarInt(0x6)...)
Expand All @@ -74,7 +74,7 @@ var _ = Describe("STREAM frame", func() {

It("writes a frame without length", func() {
f := &DatagramFrame{Data: []byte("Lorem ipsum")}
b, err := f.Write(nil, protocol.Version1)
b, err := f.Append(nil, protocol.Version1)
Expect(err).ToNot(HaveOccurred())
expected := []byte{0x30}
expected = append(expected, []byte("Lorem ipsum")...)
Expand Down Expand Up @@ -111,13 +111,13 @@ var _ = Describe("STREAM frame", func() {
if maxDataLen == 0 { // 0 means that no valid STREAM frame can be written
// check that writing a minimal size STREAM frame (i.e. with 1 byte data) is actually larger than the desired size
f.Data = []byte{0}
b, err := f.Write(nil, protocol.Version1)
b, err := f.Append(nil, protocol.Version1)
Expect(err).ToNot(HaveOccurred())
Expect(len(b)).To(BeNumerically(">", i))
continue
}
f.Data = data[:int(maxDataLen)]
b, err := f.Write(nil, protocol.Version1)
b, err := f.Append(nil, protocol.Version1)
Expect(err).ToNot(HaveOccurred())
Expect(b).To(HaveLen(i))
}
Expand All @@ -133,13 +133,13 @@ var _ = Describe("STREAM frame", func() {
if maxDataLen == 0 { // 0 means that no valid STREAM frame can be written
// check that writing a minimal size STREAM frame (i.e. with 1 byte data) is actually larger than the desired size
f.Data = []byte{0}
b, err := f.Write(nil, protocol.Version1)
b, err := f.Append(nil, protocol.Version1)
Expect(err).ToNot(HaveOccurred())
Expect(len(b)).To(BeNumerically(">", i))
continue
}
f.Data = data[:int(maxDataLen)]
b, err := f.Write(nil, protocol.Version1)
b, err := f.Append(nil, protocol.Version1)
Expect(err).ToNot(HaveOccurred())
// There's *one* pathological case, where a data length of x can be encoded into 1 byte
// but a data lengths of x+1 needs 2 bytes
Expand Down

0 comments on commit ab6d664

Please sign in to comment.