logos-messaging/go-multiaddr
1
0
Fork 0
mirror of https://github.com/logos-messaging/go-multiaddr.git synced 2026-01-02 13:03:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #181 from multiformats/marco/fix-comment

Browse Source 
Fix comment on Decapsulate
This commit is contained in:
Marco Munizaga 2022-09-08 08:17:57 -07:00 committed by GitHub
commit 91391e216e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
interface.go
View File

@ -47,9 +47,11 @@ type Multiaddr interface {
//
Encapsulate(Multiaddr) Multiaddr
// Decapsultate removes a Multiaddr wrapping. For example:
// Decapsulate removes a Multiaddr wrapping. For example:
//
// /ip4/1.2.3.4/tcp/80 decapsulate /ip4/1.2.3.4 = /tcp/80
// /ip4/1.2.3.4/tcp/80 decapsulate /tcp/80 = /ip4/1.2.3.4
// /ip4/1.2.3.4/tcp/80 decapsulate /udp/80 = /ip4/1.2.3.4/tcp/80
// /ip4/1.2.3.4/tcp/80 decapsulate /ip4/1.2.3.4 = nil
//
Decapsulate(Multiaddr) Multiaddr

19
multiaddr_test.go
View File

@ -427,6 +427,25 @@ func TestEncapsulate(t *testing.T) {
}
}
func TestDecapsulateComment(t *testing.T) {
// shows the behavior from the interface comment
m := StringCast("/ip4/1.2.3.4/tcp/80")
rest := m.Decapsulate(StringCast("/tcp/80"))
if rest.String() != "/ip4/1.2.3.4" {
t.Fatalf("Documented behavior is not correct. Expected %v saw %v", "/ip4/1.2.3.4/", rest.String())
}
m = StringCast("/ip4/1.2.3.4/tcp/80")
rest = m.Decapsulate(StringCast("/udp/80"))
if !rest.Equal(m) {
t.Fatalf("Documented behavior is not correct. Expected %v saw %v", "/ip4/1.2.3.4/tcp/80", rest.String())
}
m = StringCast("/ip4/1.2.3.4/tcp/80")
rest = m.Decapsulate(StringCast("/ip4/1.2.3.4"))
require.Nil(t, rest, "expected a nil multiaddr if we decapsulate everything")
}
func assertValueForProto(t *testing.T, a Multiaddr, p int, exp string) {
t.Logf("checking for %s in %s", ProtocolWithCode(p).Name, a)
fv, err := a.ValueForProtocol(p)