fluencelabs/scala-multiaddr
1
0
Fork 0
mirror of https://github.com/fluencelabs/scala-multiaddr synced 2025-04-24 10:42:18 +00:00
Code Issues Projects Releases Wiki Activity

add docs

Browse Source
This commit is contained in:
dmitry.shakhtarin 2018-06-20 20:46:53 +03:00
parent 580b3f4fd7
commit fab58e2758
1 changed files with 40 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
core/src/main/scala/fluence/multiaddr/Multiaddr.scala
View File

@ -19,22 +19,55 @@ package fluence.multiaddr
import fluence.multiaddr.Multiaddr.ErrorMessage
/**
* Multiaddress representation by string and list of protocols.
*/
case class Multiaddr private(address: String, protoParameters: List[ProtoParameter]) {
/**
* Wraps a given Multiaddr, returning the resulting joined Multiaddr.
* Encapsulates a Multiaddr in another Multiaddr.
*
* @return new joined Multiaddr
* Spec about encapsulate:
* https://github.com/multiformats/multiaddr#encapsulation-based-on-context
*
* val m = Multiaddr("/ip4/127.0.0.1/tcp/1234")
* println(m.encapsulate(Multiaddr.unsafe("/sctp/5678")).right.get.address)
* "/ip4/127.0.0.1/tcp/1234/sctp/5678"
*
* @param addr Multiaddr to add into this Multiaddr
* @return new Multiaddr
*/
def encapsulate(addr: Multiaddr): Either[ErrorMessage, Multiaddr] = Multiaddr(address + addr.address)
/**
* Decapsulate unwraps Multiaddr up until the given Multiaddr is found.
* Decapsulates a Multiaddr from another Multiaddr.
*
* Spec about encapsulate and decapsulate:
* https://github.com/multiformats/multiaddr#encapsulation-based-on-context
*
* val m = Multiaddr("/ip4/127.0.0.1/tcp/1234/sctp/5678")
* println(m.decapsulate(Multiaddr.unsafe("/sctp/5678")).right.get.address)
* "/ip4/127.0.0.1/tcp/1234"
*
* @param addr Multiaddr to remove from this Multiaddr
*
* @return decapsulated Multiaddr
*/
def decapsulate(addr: Multiaddr): Either[ErrorMessage, Multiaddr] = decapsulate(addr.address)
/**
* Possibility to decapsulate by part of address.
*
* Spec about encapsulate and decapsulate:
* https://github.com/multiformats/multiaddr#encapsulation-based-on-context
*
* val m = Multiaddr("/ip4/127.0.0.1/tcp/1234/sctp/5678")
* println(m.decapsulate("/sctp").right.get.address)
* "/ip4/127.0.0.1/tcp/1234"
*
* @param addr Multiaddr to remove from this Multiaddr
* @return decapsulated Multiaddr
*/
def decapsulate(addr: String): Either[ErrorMessage, Multiaddr] = {
val lastIndex = address.lastIndexOf(addr)
if (lastIndex < 0)
@ -49,6 +82,9 @@ object Multiaddr {
type ErrorMessage = String
/**
* Parse and validate multiaddr string.
*/
def apply(addr: String): Either[ErrorMessage, Multiaddr] = MultiaddrParser.parse(addr).map {
case (trimmed, protoParameters) => new Multiaddr(trimmed, protoParameters)
}