What does "with" mean in Kotlin?

Question

I've read the docs on it 3 times and I still have no idea what it does. Can someone ELI5 (Explain Like I'm Five) it please? Here's how I'm using it:

fun main(args: Array<String>) {
    val UserModel = UserModel()
    val app = Javalin.create().port(7000).start()

    with (app) {
        get("/users") {
            context -> context.json(UserModel)
        }
    }
}

Answer 1

with is used to access an object's members and methods without having to refer to the object once per access. It is (mostly) for abbreviating your code. It is frequently used when constructing an object:

// Verbose way, 204 characters:
var thing = Thingummy()
thing.component1 = something()
thing.component2 = somethingElse()
thing.component3 = constantValue
thing.component4 = foo()
thing.component5 = bar()
parent.children.add(thing)
thing.refcount = 1

// Terse way, 182 characters:
var thing = Thingummy()
with(thing) {
  component1 = something()
  component2 = somethingElse()
  component3 = constantValue
  component4 = foo()
  component5 = bar()
  parent.children.add(this)
  refcount = 1
}

Answer 2

The documentation says:

inline fun <T, R> with(receiver: T, block: T.() -> R): R (source)

Calls the specified function block with the given receiver as its receiver and returns its result.

The way I think of it is that it is calling a function (the block) where this in the scope of the block is the receiver. Whatever the block returns is the return type.

Essentially calling a method where you provide the implicit this and can return any result from it.

Here is an example to demonstrate:

val rec = "hello"
val returnedValue: Int = with(rec) {
  println("$this is ${length}")
  lastIndexOf("l")
}

The rec in this case is the receiver of the function call - the this in the scope of the block. The $length and lastIndexOf are both called on the receiver.

The return value can be seen to be an Int because that is the last method call in the body - that is the generic type parameter R of the signature.

Answer 3

The definition of with:

inline fun <T, R> with(receiver: T, block: T.() -> R): R (source)

Actually it's implementation is straight forward: The block is executed on receiver, which works for any type:

receiver.block() //that's the body of `with`

The great thing to mention here, is the parameter type T.() -> R: It's called function literal with receiver. It's actually a lambda that can access the receiver's members without any additional qualifiers.

In your example the context of with receiver app is accessed in that way.

Besides stdlib functions like with or apply, this functionality is what makes Kotlin great for writing Domain Specific Languages as it allows the creation of scopes within which you have access on certain functionalities.

Answer 4

val citizen2 = Citizen("Tom", 24, "Washington")

val age = with(citizen2) {
    println("$name -  $age  $residence ")
    age = this.age + age
    residence = "Florida"
    age+10 // returns 58
}
println("${citizen2.name} -  ${citizen2.age} - $age - ${citizen2.residence}  ")

data class Citizen(var name: String, var age: Int, var residence: String)

Output:

Tom -  24  Washington 
Tom -  48 - 58 - Florida

Note that :

• We can access age property of citizen(receiver object) with this.age or age
• last line(age+10 in this example) in the lambda of with() returns.

Answer 5

With is used to apply several operations to an object or access object's methods e.g. in this example we are accessing String's capitalize() extension method

data class Person(val name:String)
fun main(){
   val person = Person("john doe")
    with(person) {
       println(name.capitalize()) // output John Doe
    }

}

Under the hood with is a higher-order function. Here we are saying with the Person name call capitalize ( ). We don’t actually need ‘this’ because it is implicit and can be removed